Cisco-IOS-XR-infra-rsi-cfg API API Reference

API generated from Cisco-IOS-XR-infra-rsi-cfg@2017-05-01.yang

API Endpoint

http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/

URL '/' code: %2F

Schemes: http

Version: 1.0.0

Leaf Color Code:

Key Mandatory Optional

Paths

VRFS - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-infra-rsi-cfg:vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:vrfs/

Retrieve operation of resource: vrfs

200 OK

vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string"
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vrf-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vrf-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

vrf-name: string

in path

ID of vrf-name

200 OK

vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "vrf-name": "string"
}

VPN-ID - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/vpn-id/

Update operation of resource: vpn-id

vpn-id_schema

vpn-idbody object

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vpn-oui": "integer",
  "vpn-index": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPN-ID - Create

POST Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/vpn-id/

Create operation of resource: vpn-id

vpn-id_schema

vpn-idbody object

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vpn-oui": "integer",
  "vpn-index": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPN-ID - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/vpn-id/

Delete operation of resource: vpn-id

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPN-ID - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/vpn-id/

Retrieve operation of resource: vpn-id

vrf-name: string

in path

ID of vrf-name

200 OK

vpn-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "vpn-oui": "integer",
  "vpn-index": "integer"
}

AFS - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/afs/

Update operation of resource: afs

afs_schema

afsbody object

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "create": [ null ],
      "topology-name": "string",
      "saf-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Create

POST Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/afs/

Create operation of resource: afs

afs_schema

afsbody object

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "create": [ null ],
      "topology-name": "string",
      "saf-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/afs/

Delete operation of resource: afs

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/afs/

Retrieve operation of resource: afs

vrf-name: string

in path

ID of vrf-name

200 OK

afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "create": [ null ],
      "topology-name": "string",
      "saf-name": "string"
    }
  ]
}

AF - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/afs/af/{af-name saf-name topology-name}/

Update operation of resource: af

af_schema

afbody object

vrf-name: string

in path

ID of vrf-name

af-name saf-name topology-name: string

in path

ID of af-name saf-name topology-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "create": [ null ],
  "topology-name": "string",
  "saf-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Create

POST Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/afs/af/{af-name saf-name topology-name}/

Create operation of resource: af

af_schema

afbody object

vrf-name: string

in path

ID of vrf-name

af-name saf-name topology-name: string

in path

ID of af-name saf-name topology-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "create": [ null ],
  "topology-name": "string",
  "saf-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/afs/af/{af-name saf-name topology-name}/

Delete operation of resource: af

vrf-name: string

in path

ID of vrf-name

af-name saf-name topology-name: string

in path

ID of af-name saf-name topology-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:vrfs/vrf/{vrf-name}/afs/af/{af-name saf-name topology-name}/

Retrieve operation of resource: af

vrf-name: string

in path

ID of vrf-name

af-name saf-name topology-name: string

in path

ID of af-name saf-name topology-name

200 OK

af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "create": [ null ],
  "topology-name": "string",
  "saf-name": "string"
}

GLOBAL-AF - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:global-af/

Update operation of resource: global-af

AF-TABLE

global-afbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "create": [ null ],
        "topology-name": "string",
        "saf-name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-AF - Create

POST Cisco-IOS-XR-infra-rsi-cfg:global-af/

Create operation of resource: global-af

AF-TABLE

global-afbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "create": [ null ],
        "topology-name": "string",
        "saf-name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-AF - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:global-af/

Delete operation of resource: global-af

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-AF - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:global-af/

Retrieve operation of resource: global-af

200 OK

AF-TABLE

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "create": [ null ],
        "topology-name": "string",
        "saf-name": "string"
      }
    ]
  }
}

AFS - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:global-af/afs/

Update operation of resource: afs

afs_schema

afsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "create": [ null ],
      "topology-name": "string",
      "saf-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Create

POST Cisco-IOS-XR-infra-rsi-cfg:global-af/afs/

Create operation of resource: afs

afs_schema

afsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "create": [ null ],
      "topology-name": "string",
      "saf-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:global-af/afs/

Delete operation of resource: afs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:global-af/afs/

Retrieve operation of resource: afs

200 OK

afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "create": [ null ],
      "topology-name": "string",
      "saf-name": "string"
    }
  ]
}

AF - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:global-af/afs/af/{af-name saf-name topology-name}/

Update operation of resource: af

af_schema

afbody object

af-name saf-name topology-name: string

in path

ID of af-name saf-name topology-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "create": [ null ],
  "topology-name": "string",
  "saf-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Create

POST Cisco-IOS-XR-infra-rsi-cfg:global-af/afs/af/{af-name saf-name topology-name}/

Create operation of resource: af

af_schema

afbody object

af-name saf-name topology-name: string

in path

ID of af-name saf-name topology-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "create": [ null ],
  "topology-name": "string",
  "saf-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:global-af/afs/af/{af-name saf-name topology-name}/

Delete operation of resource: af

af-name saf-name topology-name: string

in path

ID of af-name saf-name topology-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:global-af/afs/af/{af-name saf-name topology-name}/

Retrieve operation of resource: af

af-name saf-name topology-name: string

in path

ID of af-name saf-name topology-name

200 OK

af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "create": [ null ],
  "topology-name": "string",
  "saf-name": "string"
}

SRLG - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/

Update operation of resource: srlg

srlg_schema

srlgbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "enable": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "inherit-node-name": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {        : { PUT          POST         DELETE        GET        
        
          : { PUT            POST           DELETE          GET          
          
            : [ PUT              POST             DELETE            GET            
            
              {
                "group-name-index": "integer",
                "group-name": "string",
                "srlg-priority": "string"
              }
            ]
          },
          "enable": [ null ]
        },
        "enable": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "interface-name": "string",        : { PUT          POST         DELETE        GET        
        
          "priority": "string",
          "enable": [ null ]
        },        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-name": "string"
            }
          ]
        }
      }
    ]
  },
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-name": "string",
        "srlg-value": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "group-name": "string",
        "enable": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SRLG - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/

Create operation of resource: srlg

srlg_schema

srlgbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "enable": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "inherit-node-name": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {        : { PUT          POST         DELETE        GET        
        
          : { PUT            POST           DELETE          GET          
          
            : [ PUT              POST             DELETE            GET            
            
              {
                "group-name-index": "integer",
                "group-name": "string",
                "srlg-priority": "string"
              }
            ]
          },
          "enable": [ null ]
        },
        "enable": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "interface-name": "string",        : { PUT          POST         DELETE        GET        
        
          "priority": "string",
          "enable": [ null ]
        },        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-name": "string"
            }
          ]
        }
      }
    ]
  },
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-name": "string",
        "srlg-value": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "group-name": "string",
        "enable": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SRLG - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/

Delete operation of resource: srlg

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SRLG - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/

Retrieve operation of resource: srlg

200 OK

srlg_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "enable": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "inherit-node-name": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {        : { PUT          POST         DELETE        GET        
        
          : { PUT            POST           DELETE          GET          
          
            : [ PUT              POST             DELETE            GET            
            
              {
                "group-name-index": "integer",
                "group-name": "string",
                "srlg-priority": "string"
              }
            ]
          },
          "enable": [ null ]
        },
        "enable": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "interface-name": "string",        : { PUT          POST         DELETE        GET        
        
          "priority": "string",
          "enable": [ null ]
        },        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-name": "string"
            }
          ]
        }
      }
    ]
  },
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-name": "string",
        "srlg-value": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "group-name": "string",
        "enable": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        }
      }
    ]
  }
}

INTERFACES - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "group-name-index": "integer",
              "group-name": "string",
              "srlg-priority": "string"
            }
          ]
        },
        "enable": [ null ]
      },
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "interface-name": "string",      : { PUT        POST       DELETE      GET      
      
        "priority": "string",
        "enable": [ null ]
      },      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-name": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "group-name-index": "integer",
              "group-name": "string",
              "srlg-priority": "string"
            }
          ]
        },
        "enable": [ null ]
      },
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "interface-name": "string",      : { PUT        POST       DELETE      GET      
      
        "priority": "string",
        "enable": [ null ]
      },      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-name": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/

Delete operation of resource: interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/

Retrieve operation of resource: interfaces

200 OK

interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "group-name-index": "integer",
              "group-name": "string",
              "srlg-priority": "string"
            }
          ]
        },
        "enable": [ null ]
      },
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "interface-name": "string",      : { PUT        POST       DELETE      GET      
      
        "priority": "string",
        "enable": [ null ]
      },      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-name": "string"
          }
        ]
      }
    }
  ]
}

INTERFACE - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "group-name-index": "integer",
          "group-name": "string",
          "srlg-priority": "string"
        }
      ]
    },
    "enable": [ null ]
  },
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "interface-name": "string",  : { PUT    POST   DELETE  GET  
  
    "priority": "string",
    "enable": [ null ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "group-name-index": "integer",
          "group-name": "string",
          "srlg-priority": "string"
        }
      ]
    },
    "enable": [ null ]
  },
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "interface-name": "string",  : { PUT    POST   DELETE  GET  
  
    "priority": "string",
    "enable": [ null ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/

Delete operation of resource: interface

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

interface-name: string

in path

ID of interface-name

200 OK

interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "group-name-index": "integer",
          "group-name": "string",
          "srlg-priority": "string"
        }
      ]
    },
    "enable": [ null ]
  },
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "interface-name": "string",  : { PUT    POST   DELETE  GET  
  
    "priority": "string",
    "enable": [ null ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-name": "string"
      }
    ]
  }
}

INCLUDE-OPTICAL - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/include-optical/

Update operation of resource: include-optical

include-optical_schema

include-opticalbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{
  "priority": "string",
  "enable": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INCLUDE-OPTICAL - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/include-optical/

Create operation of resource: include-optical

include-optical_schema

include-opticalbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{
  "priority": "string",
  "enable": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INCLUDE-OPTICAL - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/include-optical/

Delete operation of resource: include-optical

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INCLUDE-OPTICAL - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/include-optical/

Retrieve operation of resource: include-optical

interface-name: string

in path

ID of interface-name

200 OK

include-optical_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "priority": "string",
  "enable": [ null ]
}

INTERFACE-GROUP - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/

Update operation of resource: interface-group

interface-group_schema

interface-groupbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "group-name-index": "integer",
        "group-name": "string",
        "srlg-priority": "string"
      }
    ]
  },
  "enable": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-GROUP - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/

Create operation of resource: interface-group

interface-group_schema

interface-groupbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "group-name-index": "integer",
        "group-name": "string",
        "srlg-priority": "string"
      }
    ]
  },
  "enable": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-GROUP - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/

Delete operation of resource: interface-group

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-GROUP - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/

Retrieve operation of resource: interface-group

interface-name: string

in path

ID of interface-name

200 OK

interface-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "group-name-index": "integer",
        "group-name": "string",
        "srlg-priority": "string"
      }
    ]
  },
  "enable": [ null ]
}

GROUP-NAMES - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/group-names/

Update operation of resource: group-names

group-names_schema

group-namesbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "group-name-index": "integer",
      "group-name": "string",
      "srlg-priority": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-NAMES - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/group-names/

Create operation of resource: group-names

group-names_schema

group-namesbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "group-name-index": "integer",
      "group-name": "string",
      "srlg-priority": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-NAMES - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/group-names/

Delete operation of resource: group-names

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-NAMES - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/group-names/

Retrieve operation of resource: group-names

interface-name: string

in path

ID of interface-name

200 OK

group-names_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "group-name-index": "integer",
      "group-name": "string",
      "srlg-priority": "string"
    }
  ]
}

GROUP-NAME - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/group-names/group-name/{group-name-index}/

Update operation of resource: group-name

group-name_schema

group-namebody object

interface-name: string

in path

ID of interface-name

group-name-index: string

in path

ID of group-name-index

Request Content-Types: application/json

Request Example

{
  "group-name-index": "integer",
  "group-name": "string",
  "srlg-priority": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-NAME - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/group-names/group-name/{group-name-index}/

Create operation of resource: group-name

group-name_schema

group-namebody object

interface-name: string

in path

ID of interface-name

group-name-index: string

in path

ID of group-name-index

Request Content-Types: application/json

Request Example

{
  "group-name-index": "integer",
  "group-name": "string",
  "srlg-priority": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-NAME - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/group-names/group-name/{group-name-index}/

Delete operation of resource: group-name

interface-name: string

in path

ID of interface-name

group-name-index: string

in path

ID of group-name-index

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-NAME - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-group/group-names/group-name/{group-name-index}/

Retrieve operation of resource: group-name

interface-name: string

in path

ID of interface-name

group-name-index: string

in path

ID of group-name-index

200 OK

group-name_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "group-name-index": "integer",
  "group-name": "string",
  "srlg-priority": "string"
}

VALUES - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/values/

Update operation of resource: values

values_schema

valuesbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VALUES - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/values/

Create operation of resource: values

values_schema

valuesbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VALUES - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/values/

Delete operation of resource: values

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VALUES - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/values/

Retrieve operation of resource: values

interface-name: string

in path

ID of interface-name

200 OK

values_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

VALUE - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/values/value/{srlg-index}/

Update operation of resource: value

value_schema

valuebody object

interface-name: string

in path

ID of interface-name

srlg-index: string

in path

ID of srlg-index

Request Content-Types: application/json

Request Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VALUE - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/values/value/{srlg-index}/

Create operation of resource: value

value_schema

valuebody object

interface-name: string

in path

ID of interface-name

srlg-index: string

in path

ID of srlg-index

Request Content-Types: application/json

Request Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VALUE - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/values/value/{srlg-index}/

Delete operation of resource: value

interface-name: string

in path

ID of interface-name

srlg-index: string

in path

ID of srlg-index

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VALUE - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/values/value/{srlg-index}/

Retrieve operation of resource: value

interface-name: string

in path

ID of interface-name

srlg-index: string

in path

ID of srlg-index

200 OK

value_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

INTERFACE-SRLG-NAMES - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-srlg-names/

Update operation of resource: interface-srlg-names

interface-srlg-names_schema

interface-srlg-namesbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-SRLG-NAMES - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-srlg-names/

Create operation of resource: interface-srlg-names

interface-srlg-names_schema

interface-srlg-namesbody object

interface-name: string

in path

ID of interface-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-SRLG-NAMES - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-srlg-names/

Delete operation of resource: interface-srlg-names

interface-name: string

in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-SRLG-NAMES - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-srlg-names/

Retrieve operation of resource: interface-srlg-names

interface-name: string

in path

ID of interface-name

200 OK

interface-srlg-names_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-name": "string"
    }
  ]
}

INTERFACE-SRLG-NAME - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-srlg-names/interface-srlg-name/{srlg-name}/

Update operation of resource: interface-srlg-name

interface-srlg-name_schema

interface-srlg-namebody object

interface-name: string

in path

ID of interface-name

srlg-name: string

in path

ID of srlg-name

Request Content-Types: application/json

Request Example

{
  "srlg-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-SRLG-NAME - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-srlg-names/interface-srlg-name/{srlg-name}/

Create operation of resource: interface-srlg-name

interface-srlg-name_schema

interface-srlg-namebody object

interface-name: string

in path

ID of interface-name

srlg-name: string

in path

ID of srlg-name

Request Content-Types: application/json

Request Example

{
  "srlg-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-SRLG-NAME - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-srlg-names/interface-srlg-name/{srlg-name}/

Delete operation of resource: interface-srlg-name

interface-name: string

in path

ID of interface-name

srlg-name: string

in path

ID of srlg-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-SRLG-NAME - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/interfaces/interface/{interface-name}/interface-srlg-names/interface-srlg-name/{srlg-name}/

Retrieve operation of resource: interface-srlg-name

interface-name: string

in path

ID of interface-name

srlg-name: string

in path

ID of srlg-name

200 OK

interface-srlg-name_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "srlg-name": "string"
}

SRLG-NAMES - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/srlg-names/

Update operation of resource: srlg-names

srlg-names_schema

srlg-namesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-name": "string",
      "srlg-value": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SRLG-NAMES - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/srlg-names/

Create operation of resource: srlg-names

srlg-names_schema

srlg-namesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-name": "string",
      "srlg-value": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SRLG-NAMES - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/srlg-names/

Delete operation of resource: srlg-names

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SRLG-NAMES - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/srlg-names/

Retrieve operation of resource: srlg-names

200 OK

srlg-names_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-name": "string",
      "srlg-value": "integer"
    }
  ]
}

SRLG-NAME - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/srlg-names/srlg-name/{srlg-name}/

Update operation of resource: srlg-name

srlg-name_schema

srlg-namebody object

srlg-name: string

in path

ID of srlg-name

Request Content-Types: application/json

Request Example

{
  "srlg-name": "string",
  "srlg-value": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SRLG-NAME - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/srlg-names/srlg-name/{srlg-name}/

Create operation of resource: srlg-name

srlg-name_schema

srlg-namebody object

srlg-name: string

in path

ID of srlg-name

Request Content-Types: application/json

Request Example

{
  "srlg-name": "string",
  "srlg-value": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SRLG-NAME - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/srlg-names/srlg-name/{srlg-name}/

Delete operation of resource: srlg-name

srlg-name: string

in path

ID of srlg-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SRLG-NAME - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/srlg-names/srlg-name/{srlg-name}/

Retrieve operation of resource: srlg-name

srlg-name: string

in path

ID of srlg-name

200 OK

srlg-name_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "srlg-name": "string",
  "srlg-value": "integer"
}

GROUPS - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/

Update operation of resource: groups

groups_schema

groupsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "group-name": "string",
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/

Create operation of resource: groups

groups_schema

groupsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "group-name": "string",
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/

Delete operation of resource: groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/

Retrieve operation of resource: groups

200 OK

groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "group-name": "string",
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      }
    }
  ]
}

GROUP - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/

Update operation of resource: group

group_schema

groupbody object

group-name: string

in path

ID of group-name

Request Content-Types: application/json

Request Example

{
  "group-name": "string",
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/

Create operation of resource: group

group_schema

groupbody object

group-name: string

in path

ID of group-name

Request Content-Types: application/json

Request Example

{
  "group-name": "string",
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/

Delete operation of resource: group

group-name: string

in path

ID of group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/

Retrieve operation of resource: group

group-name: string

in path

ID of group-name

200 OK

group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "group-name": "string",
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  }
}

GROUP-VALUES - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/group-values/

Update operation of resource: group-values

group-values_schema

group-valuesbody object

group-name: string

in path

ID of group-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-VALUES - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/group-values/

Create operation of resource: group-values

group-values_schema

group-valuesbody object

group-name: string

in path

ID of group-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-VALUES - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/group-values/

Delete operation of resource: group-values

group-name: string

in path

ID of group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-VALUES - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/group-values/

Retrieve operation of resource: group-values

group-name: string

in path

ID of group-name

200 OK

group-values_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

GROUP-VALUE - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/group-values/group-value/{srlg-index}/

Update operation of resource: group-value

group-value_schema

group-valuebody object

group-name: string

in path

ID of group-name

srlg-index: string

in path

ID of srlg-index

Request Content-Types: application/json

Request Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-VALUE - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/group-values/group-value/{srlg-index}/

Create operation of resource: group-value

group-value_schema

group-valuebody object

group-name: string

in path

ID of group-name

srlg-index: string

in path

ID of srlg-index

Request Content-Types: application/json

Request Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-VALUE - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/group-values/group-value/{srlg-index}/

Delete operation of resource: group-value

group-name: string

in path

ID of group-name

srlg-index: string

in path

ID of srlg-index

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-VALUE - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/groups/group/{group-name}/group-values/group-value/{srlg-index}/

Retrieve operation of resource: group-value

group-name: string

in path

ID of group-name

srlg-index: string

in path

ID of srlg-index

200 OK

group-value_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

INHERIT-NODES - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/

Update operation of resource: inherit-nodes

inherit-nodes_schema

inherit-nodesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "inherit-node-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODES - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/

Create operation of resource: inherit-nodes

inherit-nodes_schema

inherit-nodesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "inherit-node-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODES - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/

Delete operation of resource: inherit-nodes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODES - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/

Retrieve operation of resource: inherit-nodes

200 OK

inherit-nodes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "inherit-node-name": "string"
    }
  ]
}

INHERIT-NODE - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/

Update operation of resource: inherit-node

inherit-node_schema

inherit-nodebody object

inherit-node-name: string

in path

ID of inherit-node-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "inherit-node-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODE - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/

Create operation of resource: inherit-node

inherit-node_schema

inherit-nodebody object

inherit-node-name: string

in path

ID of inherit-node-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "inherit-node-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODE - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/

Delete operation of resource: inherit-node

inherit-node-name: string

in path

ID of inherit-node-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODE - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/

Retrieve operation of resource: inherit-node

inherit-node-name: string

in path

ID of inherit-node-name

200 OK

inherit-node_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "inherit-node-name": "string"
}

INHERIT-NODE-VALUES - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/inherit-node-values/

Update operation of resource: inherit-node-values

inherit-node-values_schema

inherit-node-valuesbody object

inherit-node-name: string

in path

ID of inherit-node-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODE-VALUES - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/inherit-node-values/

Create operation of resource: inherit-node-values

inherit-node-values_schema

inherit-node-valuesbody object

inherit-node-name: string

in path

ID of inherit-node-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODE-VALUES - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/inherit-node-values/

Delete operation of resource: inherit-node-values

inherit-node-name: string

in path

ID of inherit-node-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODE-VALUES - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/inherit-node-values/

Retrieve operation of resource: inherit-node-values

inherit-node-name: string

in path

ID of inherit-node-name

200 OK

inherit-node-values_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

INHERIT-NODE-VALUE - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/inherit-node-values/inherit-node-value/{srlg-index}/

Update operation of resource: inherit-node-value

inherit-node-value_schema

inherit-node-valuebody object

inherit-node-name: string

in path

ID of inherit-node-name

srlg-index: string

in path

ID of srlg-index

Request Content-Types: application/json

Request Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODE-VALUE - Create

POST Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/inherit-node-values/inherit-node-value/{srlg-index}/

Create operation of resource: inherit-node-value

inherit-node-value_schema

inherit-node-valuebody object

inherit-node-name: string

in path

ID of inherit-node-name

srlg-index: string

in path

ID of srlg-index

Request Content-Types: application/json

Request Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODE-VALUE - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/inherit-node-values/inherit-node-value/{srlg-index}/

Delete operation of resource: inherit-node-value

inherit-node-name: string

in path

ID of inherit-node-name

srlg-index: string

in path

ID of srlg-index

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERIT-NODE-VALUE - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:srlg/inherit-nodes/inherit-node/{inherit-node-name}/inherit-node-values/inherit-node-value/{srlg-index}/

Retrieve operation of resource: inherit-node-value

inherit-node-name: string

in path

ID of inherit-node-name

srlg-index: string

in path

ID of srlg-index

200 OK

inherit-node-value_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

VRF-GROUPS - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/

Update operation of resource: vrf-groups

vrf-groups_schema

vrf-groupsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "vrf-name": "string"
          }
        ]
      },
      "vrf-group-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GROUPS - Create

POST Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/

Create operation of resource: vrf-groups

vrf-groups_schema

vrf-groupsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "vrf-name": "string"
          }
        ]
      },
      "vrf-group-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GROUPS - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/

Delete operation of resource: vrf-groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GROUPS - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/

Retrieve operation of resource: vrf-groups

200 OK

vrf-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "vrf-name": "string"
          }
        ]
      },
      "vrf-group-name": "string"
    }
  ]
}

VRF-GROUP - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/

Update operation of resource: vrf-group

vrf-group_schema

vrf-groupbody object

vrf-group-name: string

in path

ID of vrf-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string"
      }
    ]
  },
  "vrf-group-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GROUP - Create

POST Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/

Create operation of resource: vrf-group

vrf-group_schema

vrf-groupbody object

vrf-group-name: string

in path

ID of vrf-group-name

Request Content-Types: application/json

Request Example

{
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string"
      }
    ]
  },
  "vrf-group-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GROUP - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/

Delete operation of resource: vrf-group

vrf-group-name: string

in path

ID of vrf-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GROUP - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/

Retrieve operation of resource: vrf-group

vrf-group-name: string

in path

ID of vrf-group-name

200 OK

vrf-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "enable": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string"
      }
    ]
  },
  "vrf-group-name": "string"
}

VRFS - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

vrf-group-name: string

in path

ID of vrf-group-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

vrf-group-name: string

in path

ID of vrf-group-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/vrfs/

Delete operation of resource: vrfs

vrf-group-name: string

in path

ID of vrf-group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/vrfs/

Retrieve operation of resource: vrfs

vrf-group-name: string

in path

ID of vrf-group-name

200 OK

vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string"
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

vrf-group-name: string

in path

ID of vrf-group-name

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vrf-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

vrf-group-name: string

in path

ID of vrf-group-name

vrf-name: string

in path

ID of vrf-name

Request Content-Types: application/json

Request Example

{
  "vrf-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

vrf-group-name: string

in path

ID of vrf-group-name

vrf-name: string

in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:vrf-groups/vrf-group/{vrf-group-name}/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

vrf-group-name: string

in path

ID of vrf-group-name

vrf-name: string

in path

ID of vrf-name

200 OK

vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "vrf-name": "string"
}

SELECTIVE-VRF-DOWNLOAD - Update

PUT Cisco-IOS-XR-infra-rsi-cfg:selective-vrf-download/

Update operation of resource: selective-vrf-download

selective-vrf-download_schema

selective-vrf-downloadbody object

Request Content-Types: application/json

Request Example

{
  "disable": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SELECTIVE-VRF-DOWNLOAD - Create

POST Cisco-IOS-XR-infra-rsi-cfg:selective-vrf-download/

Create operation of resource: selective-vrf-download

selective-vrf-download_schema

selective-vrf-downloadbody object

Request Content-Types: application/json

Request Example

{
  "disable": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SELECTIVE-VRF-DOWNLOAD - Delete

DELETE Cisco-IOS-XR-infra-rsi-cfg:selective-vrf-download/

Delete operation of resource: selective-vrf-download

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SELECTIVE-VRF-DOWNLOAD - Retrieve

GET Cisco-IOS-XR-infra-rsi-cfg:selective-vrf-download/

Retrieve operation of resource: selective-vrf-download

200 OK

selective-vrf-download_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "disable": [ null ]
}

GLOBAL-INTERFACE-CONFIGURATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Update operation of resource: global-interface-configuration

a1_global-interface-configuration_schema

global-interface-configurationbody object

Request Content-Types: application/json

Request Example

{
  "link-status": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-INTERFACE-CONFIGURATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Create operation of resource: global-interface-configuration

a1_global-interface-configuration_schema

global-interface-configurationbody object

Request Content-Types: application/json

Request Example

{
  "link-status": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-INTERFACE-CONFIGURATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Delete operation of resource: global-interface-configuration

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-INTERFACE-CONFIGURATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:global-interface-configuration/

Retrieve operation of resource: global-interface-configuration

200 OK

a1_global-interface-configuration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "link-status": "string"
}

INTERFACE-CONFIGURATIONS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Update operation of resource: interface-configurations

a1_interface-configurations_schema

interface-configurationsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "description": "string",
      "secondary-admin-state": "string",
      "interface-virtual": [ null ],
      "link-status": [ null ],
      "bandwidth": "integer",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "owner": "string",
            "mtu": "integer"
          }
        ]
      },
      "vrf": "string",
      "shutdown": [ null ],
      "active": "string",      : { PUT        POST       DELETE      GET      
      
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      "interface-mode-non-physical": "string",
      "interface-name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "saf-name": "string",
            "topology-name": "string"
          }
        ],        : [ PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "saf-name": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATIONS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Create operation of resource: interface-configurations

a1_interface-configurations_schema

interface-configurationsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "description": "string",
      "secondary-admin-state": "string",
      "interface-virtual": [ null ],
      "link-status": [ null ],
      "bandwidth": "integer",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "owner": "string",
            "mtu": "integer"
          }
        ]
      },
      "vrf": "string",
      "shutdown": [ null ],
      "active": "string",      : { PUT        POST       DELETE      GET      
      
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      "interface-mode-non-physical": "string",
      "interface-name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "saf-name": "string",
            "topology-name": "string"
          }
        ],        : [ PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "saf-name": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATIONS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Delete operation of resource: interface-configurations

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATIONS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/

Retrieve operation of resource: interface-configurations

200 OK

a1_interface-configurations_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "description": "string",
      "secondary-admin-state": "string",
      "interface-virtual": [ null ],
      "link-status": [ null ],
      "bandwidth": "integer",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "owner": "string",
            "mtu": "integer"
          }
        ]
      },
      "vrf": "string",
      "shutdown": [ null ],
      "active": "string",      : { PUT        POST       DELETE      GET      
      
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      "interface-mode-non-physical": "string",
      "interface-name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "saf-name": "string",
            "topology-name": "string"
          }
        ],        : [ PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "saf-name": "string"
          }
        ]
      }
    }
  ]
}

INTERFACE-CONFIGURATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Update operation of resource: interface-configuration

a1_interface-configuration_schema

interface-configurationbody object

active interface-name: string

in path

ID of active interface-name

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "description": "string",
  "secondary-admin-state": "string",
  "interface-virtual": [ null ],
  "link-status": [ null ],
  "bandwidth": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "owner": "string",
        "mtu": "integer"
      }
    ]
  },
  "vrf": "string",
  "shutdown": [ null ],
  "active": "string",  : { PUT    POST   DELETE  GET  
  
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  "interface-mode-non-physical": "string",
  "interface-name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "saf-name": "string",
        "topology-name": "string"
      }
    ],    : [ PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "saf-name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Create operation of resource: interface-configuration

a1_interface-configuration_schema

interface-configurationbody object

active interface-name: string

in path

ID of active interface-name

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "description": "string",
  "secondary-admin-state": "string",
  "interface-virtual": [ null ],
  "link-status": [ null ],
  "bandwidth": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "owner": "string",
        "mtu": "integer"
      }
    ]
  },
  "vrf": "string",
  "shutdown": [ null ],
  "active": "string",  : { PUT    POST   DELETE  GET  
  
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  "interface-mode-non-physical": "string",
  "interface-name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "saf-name": "string",
        "topology-name": "string"
      }
    ],    : [ PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "saf-name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Delete operation of resource: interface-configuration

active interface-name: string

in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-CONFIGURATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/

Retrieve operation of resource: interface-configuration

active interface-name: string

in path

ID of active interface-name

200 OK

a1_interface-configuration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "description": "string",
  "secondary-admin-state": "string",
  "interface-virtual": [ null ],
  "link-status": [ null ],
  "bandwidth": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "owner": "string",
        "mtu": "integer"
      }
    ]
  },
  "vrf": "string",
  "shutdown": [ null ],
  "active": "string",  : { PUT    POST   DELETE  GET  
  
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  "interface-mode-non-physical": "string",
  "interface-name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "saf-name": "string",
        "topology-name": "string"
      }
    ],    : [ PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "saf-name": "string"
      }
    ]
  }
}

DAMPENING - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Update operation of resource: dampening

a1_dampening_schema

dampeningbody object

active interface-name: string

in path

ID of active interface-name

Request Content-Types: application/json

Request Example

{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Create operation of resource: dampening

a1_dampening_schema

dampeningbody object

active interface-name: string

in path

ID of active interface-name

Request Content-Types: application/json

Request Example

{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Delete operation of resource: dampening

active interface-name: string

in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/dampening/

Retrieve operation of resource: dampening

active interface-name: string

in path

ID of active interface-name

200 OK

a1_dampening_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}

MTUS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Update operation of resource: mtus

a1_mtus_schema

mtusbody object

active interface-name: string

in path

ID of active interface-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTUS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Create operation of resource: mtus

a1_mtus_schema

mtusbody object

active interface-name: string

in path

ID of active interface-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTUS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Delete operation of resource: mtus

active interface-name: string

in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTUS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/

Retrieve operation of resource: mtus

active interface-name: string

in path

ID of active interface-name

200 OK

a1_mtus_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}

MTU - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Update operation of resource: mtu

a1_mtu_schema

mtubody object

active interface-name: string

in path

ID of active interface-name

owner: string

in path

ID of owner

Request Content-Types: application/json

Request Example

{
  "owner": "string",
  "mtu": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTU - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Create operation of resource: mtu

a1_mtu_schema

mtubody object

active interface-name: string

in path

ID of active interface-name

owner: string

in path

ID of owner

Request Content-Types: application/json

Request Example

{
  "owner": "string",
  "mtu": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTU - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Delete operation of resource: mtu

active interface-name: string

in path

ID of active interface-name

owner: string

in path

ID of owner

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MTU - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/mtus/mtu/{owner}/

Retrieve operation of resource: mtu

active interface-name: string

in path

ID of active interface-name

owner: string

in path

ID of owner

200 OK

a1_mtu_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "owner": "string",
  "mtu": "integer"
}

ENCAPSULATION - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Update operation of resource: encapsulation

a1_encapsulation_schema

encapsulationbody object

active interface-name: string

in path

ID of active interface-name

Request Content-Types: application/json

Request Example

{
  "encapsulation": "string",
  "capsulation-options": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Create operation of resource: encapsulation

a1_encapsulation_schema

encapsulationbody object

active interface-name: string

in path

ID of active interface-name

Request Content-Types: application/json

Request Example

{
  "encapsulation": "string",
  "capsulation-options": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Delete operation of resource: encapsulation

active interface-name: string

in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCAPSULATION - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/encapsulation/

Retrieve operation of resource: encapsulation

active interface-name: string

in path

ID of active interface-name

200 OK

a1_encapsulation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "encapsulation": "string",
  "capsulation-options": "integer"
}

AFS - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/

Update operation of resource: afs

a1_afs_schema

afsbody object

active interface-name: string

in path

ID of active interface-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "saf-name": "string",
      "topology-name": "string"
    }
  ],  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "saf-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/

Create operation of resource: afs

a1_afs_schema

afsbody object

active interface-name: string

in path

ID of active interface-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "saf-name": "string",
      "topology-name": "string"
    }
  ],  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "saf-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/

Delete operation of resource: afs

active interface-name: string

in path

ID of active interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/

Retrieve operation of resource: afs

active interface-name: string

in path

ID of active interface-name

200 OK

a1_afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "saf-name": "string",
      "topology-name": "string"
    }
  ],  : [ PUT    POST   DELETE  GET  
  
    {
      "af-name": "string",
      "saf-name": "string"
    }
  ]
}

AF - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/af/{af-name saf-name}/

Update operation of resource: af

a1_af_schema

afbody object

active interface-name: string

in path

ID of active interface-name

af-name saf-name: string

in path

ID of af-name saf-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "saf-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/af/{af-name saf-name}/

Create operation of resource: af

a1_af_schema

afbody object

active interface-name: string

in path

ID of active interface-name

af-name saf-name: string

in path

ID of af-name saf-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "saf-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/af/{af-name saf-name}/

Delete operation of resource: af

active interface-name: string

in path

ID of active interface-name

af-name saf-name: string

in path

ID of af-name saf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/af/{af-name saf-name}/

Retrieve operation of resource: af

active interface-name: string

in path

ID of active interface-name

af-name saf-name: string

in path

ID of af-name saf-name

200 OK

a1_af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "saf-name": "string"
}

AF-TOPOLOGY-NAME - Update

PUT Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/af-topology-name/{topology-name af-name saf-name}/

Update operation of resource: af-topology-name

a1_af-topology-name_schema

af-topology-namebody object

active interface-name: string

in path

ID of active interface-name

topology-name af-name saf-name: string

in path

ID of topology-name af-name saf-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "saf-name": "string",
  "topology-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-TOPOLOGY-NAME - Create

POST Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/af-topology-name/{topology-name af-name saf-name}/

Create operation of resource: af-topology-name

a1_af-topology-name_schema

af-topology-namebody object

active interface-name: string

in path

ID of active interface-name

topology-name af-name saf-name: string

in path

ID of topology-name af-name saf-name

Request Content-Types: application/json

Request Example

{
  "af-name": "string",
  "saf-name": "string",
  "topology-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-TOPOLOGY-NAME - Delete

DELETE Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/af-topology-name/{topology-name af-name saf-name}/

Delete operation of resource: af-topology-name

active interface-name: string

in path

ID of active interface-name

topology-name af-name saf-name: string

in path

ID of topology-name af-name saf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF-TOPOLOGY-NAME - Retrieve

GET Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration/{active interface-name}/afs/af-topology-name/{topology-name af-name saf-name}/

Retrieve operation of resource: af-topology-name

active interface-name: string

in path

ID of active interface-name

topology-name af-name saf-name: string

in path

ID of topology-name af-name saf-name

200 OK

a1_af-topology-name_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "af-name": "string",
  "saf-name": "string",
  "topology-name": "string"
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/

Update operation of resource: snmp

a2_snmp_schema

snmpbody object

Request Content-Types: application/json

Request Example

{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/

Create operation of resource: snmp

a2_snmp_schema

snmpbody object

Request Content-Types: application/json

Request Example

{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/

Retrieve operation of resource: snmp

200 OK

a2_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

ENCRYPTED-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Update operation of resource: encrypted-community-maps

a2_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Create operation of resource: encrypted-community-maps

a2_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Delete operation of resource: encrypted-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Retrieve operation of resource: encrypted-community-maps

200 OK

a2_encrypted-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

ENCRYPTED-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Update operation of resource: encrypted-community-map

a2_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Create operation of resource: encrypted-community-map

a2_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Delete operation of resource: encrypted-community-map

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Retrieve operation of resource: encrypted-community-map

community-name: string

in path

ID of community-name

200 OK

a2_encrypted-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

VIEWS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Update operation of resource: views

a2_views_schema

viewsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Create operation of resource: views

a2_views_schema

viewsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Delete operation of resource: views

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Retrieve operation of resource: views

200 OK

a2_views_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

VIEW - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Update operation of resource: view

a2_view_schema

viewbody object

view-name family: string

in path

ID of view-name family

Request Content-Types: application/json

Request Example

{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Create operation of resource: view

a2_view_schema

viewbody object

view-name family: string

in path

ID of view-name family

Request Content-Types: application/json

Request Example

{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Delete operation of resource: view

view-name family: string

in path

ID of view-name family

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Retrieve operation of resource: view

view-name family: string

in path

ID of view-name family

200 OK

a2_view_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

LOGGING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Update operation of resource: logging

a2_logging_schema

loggingbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Create operation of resource: logging

a2_logging_schema

loggingbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Delete operation of resource: logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Retrieve operation of resource: logging

200 OK

a2_logging_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Update operation of resource: threshold

a2_threshold_schema

thresholdbody object

Request Content-Types: application/json

Request Example

{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Create operation of resource: threshold

a2_threshold_schema

thresholdbody object

Request Content-Types: application/json

Request Example

{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Delete operation of resource: threshold

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Retrieve operation of resource: threshold

200 OK

a2_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

ADMINISTRATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Update operation of resource: administration

a2_administration_schema

administrationbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Create operation of resource: administration

a2_administration_schema

administrationbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Delete operation of resource: administration

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Retrieve operation of resource: administration

200 OK

a2_administration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

DEFAULT-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Update operation of resource: default-communities

a2_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Create operation of resource: default-communities

a2_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Delete operation of resource: default-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Retrieve operation of resource: default-communities

200 OK

a2_default-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

DEFAULT-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Update operation of resource: default-community

a2_default-community_schema

default-communitybody object

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Create operation of resource: default-community

a2_default-community_schema

default-communitybody object

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Delete operation of resource: default-community

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Retrieve operation of resource: default-community

community-name: string

in path

ID of community-name

200 OK

a2_default-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

ENCRYPTED-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Update operation of resource: encrypted-communities

a2_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Create operation of resource: encrypted-communities

a2_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Delete operation of resource: encrypted-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Retrieve operation of resource: encrypted-communities

200 OK

a2_encrypted-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

ENCRYPTED-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Update operation of resource: encrypted-community

a2_encrypted-community_schema

encrypted-communitybody object

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Create operation of resource: encrypted-community

a2_encrypted-community_schema

encrypted-communitybody object

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Delete operation of resource: encrypted-community

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Retrieve operation of resource: encrypted-community

community-name: string

in path

ID of community-name

200 OK

a2_encrypted-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

AGENT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Update operation of resource: agent

a2_agent_schema

agentbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Create operation of resource: agent

a2_agent_schema

agentbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Delete operation of resource: agent

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Retrieve operation of resource: agent

200 OK

a2_agent_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

ENGINE-ID - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Update operation of resource: engine-id

a2_engine-id_schema

engine-idbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Create operation of resource: engine-id

a2_engine-id_schema

engine-idbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Delete operation of resource: engine-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Retrieve operation of resource: engine-id

200 OK

a2_engine-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

REMOTES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Update operation of resource: remotes

a2_remotes_schema

remotesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Create operation of resource: remotes

a2_remotes_schema

remotesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Delete operation of resource: remotes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Retrieve operation of resource: remotes

200 OK

a2_remotes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

REMOTE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Update operation of resource: remote

a2_remote_schema

remotebody object

remote-address: string

in path

ID of remote-address

Request Content-Types: application/json

Request Example

{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Create operation of resource: remote

a2_remote_schema

remotebody object

remote-address: string

in path

ID of remote-address

Request Content-Types: application/json

Request Example

{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Delete operation of resource: remote

remote-address: string

in path

ID of remote-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Retrieve operation of resource: remote

remote-address: string

in path

ID of remote-address

200 OK

a2_remote_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

TRAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Update operation of resource: trap

a2_trap_schema

trapbody object

Request Content-Types: application/json

Request Example

{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Create operation of resource: trap

a2_trap_schema

trapbody object

Request Content-Types: application/json

Request Example

{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Delete operation of resource: trap

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Retrieve operation of resource: trap

200 OK

a2_trap_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

DROP-PACKET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Update operation of resource: drop-packet

a2_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json

Request Example

{
  "unknown-user": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Create operation of resource: drop-packet

a2_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json

Request Example

{
  "unknown-user": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Delete operation of resource: drop-packet

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Retrieve operation of resource: drop-packet

200 OK

a2_drop-packet_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "unknown-user": [ null ]
}

IPV6 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Update operation of resource: ipv6

a2_ipv6_schema

ipv6body object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Create operation of resource: ipv6

a2_ipv6_schema

ipv6body object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Delete operation of resource: ipv6

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Retrieve operation of resource: ipv6

200 OK

a2_ipv6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Update operation of resource: tos

a2_tos_schema

tosbody object

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Create operation of resource: tos

a2_tos_schema

tosbody object

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Retrieve operation of resource: tos

200 OK

a2_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

IPV4 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Update operation of resource: ipv4

a2_ipv4_schema

ipv4body object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Create operation of resource: ipv4

a2_ipv4_schema

ipv4body object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Delete operation of resource: ipv4

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Retrieve operation of resource: ipv4

200 OK

a2_ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Update operation of resource: tos

a2_tos_schema

tosbody object

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Create operation of resource: tos

a2_tos_schema

tosbody object

Request Content-Types: application/json

Request Example

{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Retrieve operation of resource: tos

200 OK

a2_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

SYSTEM - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Update operation of resource: system

a2_system_schema

systembody object

Request Content-Types: application/json

Request Example

{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Create operation of resource: system

a2_system_schema

systembody object

Request Content-Types: application/json

Request Example

{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Delete operation of resource: system

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Retrieve operation of resource: system

200 OK

a2_system_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Update operation of resource: target

a2_target_schema

targetbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Create operation of resource: target

a2_target_schema

targetbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Delete operation of resource: target

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Retrieve operation of resource: target

200 OK

a2_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

TARGETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Update operation of resource: targets

a2_targets_schema

targetsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Create operation of resource: targets

a2_targets_schema

targetsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Delete operation of resource: targets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Retrieve operation of resource: targets

200 OK

a2_targets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Update operation of resource: target

a2_target_schema

targetbody object

target-list-name: string

in path

ID of target-list-name

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Create operation of resource: target

a2_target_schema

targetbody object

target-list-name: string

in path

ID of target-list-name

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Delete operation of resource: target

target-list-name: string

in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Retrieve operation of resource: target

target-list-name: string

in path

ID of target-list-name

200 OK

a2_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

VRF-NAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Update operation of resource: vrf-names

a2_vrf-names_schema

vrf-namesbody object

target-list-name: string

in path

ID of target-list-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Create operation of resource: vrf-names

a2_vrf-names_schema

vrf-namesbody object

target-list-name: string

in path

ID of target-list-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Delete operation of resource: vrf-names

target-list-name: string

in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Retrieve operation of resource: vrf-names

target-list-name: string

in path

ID of target-list-name

200 OK

a2_vrf-names_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}

VRF-NAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Update operation of resource: vrf-name

a2_vrf-name_schema

vrf-namebody object

target-list-name: string

in path

ID of target-list-name

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Create operation of resource: vrf-name

a2_vrf-name_schema

vrf-namebody object

target-list-name: string

in path

ID of target-list-name

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Delete operation of resource: vrf-name

target-list-name: string

in path

ID of target-list-name

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Retrieve operation of resource: vrf-name

target-list-name: string

in path

ID of target-list-name

in path

ID of name

200 OK

a2_vrf-name_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "name": "string"
}

TARGET-ADDRESSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Update operation of resource: target-addresses

a2_target-addresses_schema

target-addressesbody object

target-list-name: string

in path

ID of target-list-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Create operation of resource: target-addresses

a2_target-addresses_schema

target-addressesbody object

target-list-name: string

in path

ID of target-list-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Delete operation of resource: target-addresses

target-list-name: string

in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Retrieve operation of resource: target-addresses

target-list-name: string

in path

ID of target-list-name

200 OK

a2_target-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}

TARGET-ADDRESS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Update operation of resource: target-address

a2_target-address_schema

target-addressbody object

target-list-name: string

in path

ID of target-list-name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{
  "ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Create operation of resource: target-address

a2_target-address_schema

target-addressbody object

target-list-name: string

in path

ID of target-list-name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{
  "ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Delete operation of resource: target-address

target-list-name: string

in path

ID of target-list-name

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Retrieve operation of resource: target-address

target-list-name: string

in path

ID of target-list-name

ip-address: string

in path

ID of ip-address

200 OK

a2_target-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "ip-address": "string"
}

NOTIFICATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Update operation of resource: notification

a2_notification_schema

notificationbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    "role-change": [ null ]
  },  : { PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Create operation of resource: notification

a2_notification_schema

notificationbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    "role-change": [ null ]
  },  : { PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Delete operation of resource: notification

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Retrieve operation of resource: notification

200 OK

a2_notification_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    "role-change": [ null ]
  },  : { PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Update operation of resource: snmp

a2_snmp_schema

snmpbody object

Request Content-Types: application/json

Request Example

{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Create operation of resource: snmp

a2_snmp_schema

snmpbody object

Request Content-Types: application/json

Request Example

{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Retrieve operation of resource: snmp

200 OK

a2_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

SELECTIVE-VRF-DOWNLOAD - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/selective-vrf-download/

Update operation of resource: selective-vrf-download

a2_selective-vrf-download_schema

selective-vrf-downloadbody object

Request Content-Types: application/json

Request Example

{
  "role-change": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SELECTIVE-VRF-DOWNLOAD - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/selective-vrf-download/

Create operation of resource: selective-vrf-download

a2_selective-vrf-download_schema

selective-vrf-downloadbody object

Request Content-Types: application/json

Request Example

{
  "role-change": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SELECTIVE-VRF-DOWNLOAD - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/selective-vrf-download/

Delete operation of resource: selective-vrf-download

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SELECTIVE-VRF-DOWNLOAD - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/selective-vrf-download/

Retrieve operation of resource: selective-vrf-download

200 OK

a2_selective-vrf-download_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "role-change": [ null ]
}

CORRELATOR - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Update operation of resource: correlator

a2_correlator_schema

correlatorbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],              : { PUT                POST               DELETE              GET              
              
                : [ PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",                    : { PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],              : { PUT                POST               DELETE              GET              
              
                : [ PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",                    : { PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",        : { PUT          POST         DELETE        GET        
        
          "all": [ null ],          : { PUT            POST           DELETE          GET          
          
            : [ PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "name": "string",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },        : { PUT          POST         DELETE        GET        
        
          "all": [ null ],          : { PUT            POST           DELETE          GET          
          
            : [ PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Create operation of resource: correlator

a2_correlator_schema

correlatorbody object

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],              : { PUT                POST               DELETE              GET              
              
                : [ PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",                    : { PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],              : { PUT                POST               DELETE              GET              
              
                : [ PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",                    : { PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",        : { PUT          POST         DELETE        GET        
        
          "all": [ null ],          : { PUT            POST           DELETE          GET          
          
            : [ PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "name": "string",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },        : { PUT          POST         DELETE        GET        
        
          "all": [ null ],          : { PUT            POST           DELETE          GET          
          
            : [ PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Delete operation of resource: correlator

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Retrieve operation of resource: correlator

200 OK

a2_correlator_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],              : { PUT                POST               DELETE              GET              
              
                : [ PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",                    : { PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],              : { PUT                POST               DELETE              GET              
              
                : [ PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",                    : { PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",        : { PUT          POST         DELETE        GET        
        
          "all": [ null ],          : { PUT            POST           DELETE          GET          
          
            : [ PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "name": "string",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },        : { PUT          POST         DELETE        GET        
        
          "all": [ null ],          : { PUT            POST           DELETE          GET          
          
            : [ PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

RULES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Update operation of resource: rules

a2_rules_schema

rulesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],            : { PUT              POST             DELETE            GET            
            
              : [ PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",                  : { PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],            : { PUT              POST             DELETE            GET            
            
              : [ PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",                  : { PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",      : { PUT        POST       DELETE      GET      
      
        "all": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Create operation of resource: rules

a2_rules_schema

rulesbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],            : { PUT              POST             DELETE            GET            
            
              : [ PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",                  : { PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],            : { PUT              POST             DELETE            GET            
            
              : [ PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",                  : { PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",      : { PUT        POST       DELETE      GET      
      
        "all": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Delete operation of resource: rules

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Retrieve operation of resource: rules

200 OK

a2_rules_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],            : { PUT              POST             DELETE            GET            
            
              : [ PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",                  : { PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],            : { PUT              POST             DELETE            GET            
            
              : [ PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",                  : { PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",      : { PUT        POST       DELETE      GET      
      
        "all": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

RULE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Update operation of resource: rule

a2_rule_schema

rulebody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",              : { PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",              : { PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",  : { PUT    POST   DELETE  GET  
  
    "all": [ null ],    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Create operation of resource: rule

a2_rule_schema

rulebody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",              : { PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",              : { PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",  : { PUT    POST   DELETE  GET  
  
    "all": [ null ],    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Delete operation of resource: rule

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Retrieve operation of resource: rule

in path

ID of name

200 OK

a2_rule_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",              : { PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string",              : { PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",  : { PUT    POST   DELETE  GET  
  
    "all": [ null ],    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Update operation of resource: root-causes

a2_root-causes_schema

root-causesbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",            : { PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Create operation of resource: root-causes

a2_root-causes_schema

root-causesbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",            : { PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Delete operation of resource: root-causes

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Retrieve operation of resource: root-causes

in path

ID of name

200 OK

a2_root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",            : { PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Update operation of resource: root-cause

a2_root-cause_schema

root-causebody object

in path

ID of name

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "oid": "string",
  "created": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",        : { PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Create operation of resource: root-cause

a2_root-cause_schema

root-causebody object

in path

ID of name

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "oid": "string",
  "created": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",        : { PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Delete operation of resource: root-cause

in path

ID of name

oid: string

in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Retrieve operation of resource: root-cause

in path

ID of name

oid: string

in path

ID of oid

200 OK

a2_root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "oid": "string",
  "created": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",        : { PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a2_var-binds_schema

var-bindsbody object

in path

ID of name

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",      : { PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a2_var-binds_schema

var-bindsbody object

in path

ID of name

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",      : { PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

in path

ID of name

oid: string

in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

in path

ID of name

oid: string

in path

ID of oid

200 OK

a2_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",      : { PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a2_var-bind_schema

var-bindbody object

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "oid": "string",  : { PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a2_var-bind_schema

var-bindbody object

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "oid": "string",  : { PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

200 OK

a2_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "oid": "string",  : { PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a2_match_schema

matchbody object

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "index": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a2_match_schema

matchbody object

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "index": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

200 OK

a2_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "index": "string",
  "value": "string"
}

NON-ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Update operation of resource: non-root-causes

a2_non-root-causes_schema

non-root-causesbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",            : { PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Create operation of resource: non-root-causes

a2_non-root-causes_schema

non-root-causesbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",            : { PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Delete operation of resource: non-root-causes

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Retrieve operation of resource: non-root-causes

in path

ID of name

200 OK

a2_non-root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "oid": "string",            : { PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

NON-ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Update operation of resource: non-root-cause

a2_non-root-cause_schema

non-root-causebody object

in path

ID of name

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "oid": "string",
  "created": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",        : { PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Create operation of resource: non-root-cause

a2_non-root-cause_schema

non-root-causebody object

in path

ID of name

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "oid": "string",
  "created": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",        : { PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Delete operation of resource: non-root-cause

in path

ID of name

oid: string

in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Retrieve operation of resource: non-root-cause

in path

ID of name

oid: string

in path

ID of oid

200 OK

a2_non-root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "oid": "string",
  "created": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "oid": "string",        : { PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a2_var-binds_schema

var-bindsbody object

in path

ID of name

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",      : { PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a2_var-binds_schema

var-bindsbody object

in path

ID of name

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",      : { PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

in path

ID of name

oid: string

in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

in path

ID of name

oid: string

in path

ID of oid

200 OK

a2_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string",      : { PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a2_var-bind_schema

var-bindbody object

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "oid": "string",  : { PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a2_var-bind_schema

var-bindbody object

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "oid": "string",  : { PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

200 OK

a2_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "oid": "string",  : { PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a2_match_schema

matchbody object

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "index": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a2_match_schema

matchbody object

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "index": "string",
  "value": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

in path

ID of name

oid: string

in path

ID of oid

oid: string

in path

ID of oid

200 OK

a2_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "index": "string",
  "value": "string"
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Update operation of resource: applied-to

a2_applied-to_schema

applied-tobody object

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "all": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Create operation of resource: applied-to

a2_applied-to_schema

applied-tobody object

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "all": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Delete operation of resource: applied-to

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Retrieve operation of resource: applied-to

in path

ID of name

200 OK

a2_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "all": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Update operation of resource: hosts

a2_hosts_schema

hostsbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Create operation of resource: hosts

a2_hosts_schema

hostsbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Delete operation of resource: hosts

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

in path

ID of name

200 OK

a2_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a2_host_schema

hostbody object

in path

ID of name

ip-address port: string

in path

ID of ip-address port

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a2_host_schema

hostbody object

in path

ID of name

ip-address port: string

in path

ID of ip-address port

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

in path

ID of name

ip-address port: string

in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

in path

ID of name

ip-address port: string

in path

ID of ip-address port

200 OK

a2_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "port": "string",
  "ip-address": "string"
}

RULE-SETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Update operation of resource: rule-sets

a2_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },      : { PUT        POST       DELETE      GET      
      
        "all": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Create operation of resource: rule-sets

a2_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },      : { PUT        POST       DELETE      GET      
      
        "all": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Delete operation of resource: rule-sets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Retrieve operation of resource: rule-sets

200 OK

a2_rule-sets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },      : { PUT        POST       DELETE      GET      
      
        "all": [ null ],        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

RULE-SET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Update operation of resource: rule-set

a2_rule-set_schema

rule-setbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    "all": [ null ],    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Create operation of resource: rule-set

a2_rule-set_schema

rule-setbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    "all": [ null ],    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Delete operation of resource: rule-set

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Retrieve operation of resource: rule-set

in path

ID of name

200 OK

a2_rule-set_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    "all": [ null ],    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

RULENAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Update operation of resource: rulenames

a2_rulenames_schema

rulenamesbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Create operation of resource: rulenames

a2_rulenames_schema

rulenamesbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Delete operation of resource: rulenames

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Retrieve operation of resource: rulenames

in path

ID of name

200 OK

a2_rulenames_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}

RULENAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Update operation of resource: rulename

a2_rulename_schema

rulenamebody object

in path

ID of name

rulename: string

in path

ID of rulename

Request Content-Types: application/json

Request Example

{
  "rulename": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Create operation of resource: rulename

a2_rulename_schema

rulenamebody object

in path

ID of name

rulename: string

in path

ID of rulename

Request Content-Types: application/json

Request Example

{
  "rulename": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Delete operation of resource: rulename

in path

ID of name

rulename: string

in path

ID of rulename

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Retrieve operation of resource: rulename

in path

ID of name

rulename: string

in path

ID of rulename

200 OK

a2_rulename_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "rulename": "string"
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Update operation of resource: applied-to

a2_applied-to_schema

applied-tobody object

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "all": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Create operation of resource: applied-to

a2_applied-to_schema

applied-tobody object

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "all": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Delete operation of resource: applied-to

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Retrieve operation of resource: applied-to

in path

ID of name

200 OK

a2_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "all": [ null ],  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Update operation of resource: hosts

a2_hosts_schema

hostsbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Create operation of resource: hosts

a2_hosts_schema

hostsbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Delete operation of resource: hosts

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

in path

ID of name

200 OK

a2_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a2_host_schema

hostbody object

in path

ID of name

ip-address port: string

in path

ID of ip-address port

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a2_host_schema

hostbody object

in path

ID of name

ip-address port: string

in path

ID of ip-address port

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "ip-address": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

in path

ID of name

ip-address port: string

in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

in path

ID of name

ip-address port: string

in path

ID of ip-address port

200 OK

a2_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "port": "string",
  "ip-address": "string"
}

BULK-STATS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Update operation of resource: bulk-stats

a2_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json

Request Example

{
  "memory": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",        : { PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Create operation of resource: bulk-stats

a2_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json

Request Example

{
  "memory": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",        : { PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Delete operation of resource: bulk-stats

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Retrieve operation of resource: bulk-stats

200 OK

a2_bulk-stats_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "memory": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",        : { PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Update operation of resource: schemas

a2_schemas_schema

schemasbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",      : { PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Create operation of resource: schemas

a2_schemas_schema

schemasbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",      : { PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Delete operation of resource: schemas

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Retrieve operation of resource: schemas

200 OK

a2_schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",      : { PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Update operation of resource: schema

a2_schema_schema

schemabody object

schema-name: string

in path

ID of schema-name

Request Content-Types: application/json

Request Example

{
  "schema-name": "string",  : { PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Create operation of resource: schema

a2_schema_schema

schemabody object

schema-name: string

in path

ID of schema-name

Request Content-Types: application/json

Request Example

{
  "schema-name": "string",  : { PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Delete operation of resource: schema

schema-name: string

in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Retrieve operation of resource: schema

schema-name: string

in path

ID of schema-name

200 OK

a2_schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "schema-name": "string",  : { PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

INSTANCE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Update operation of resource: instance

a2_instance_schema

instancebody object

schema-name: string

in path

ID of schema-name

Request Content-Types: application/json

Request Example

{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Create operation of resource: instance

a2_instance_schema

instancebody object

schema-name: string

in path

ID of schema-name

Request Content-Types: application/json

Request Example

{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Delete operation of resource: instance

schema-name: string

in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Retrieve operation of resource: instance

schema-name: string

in path

ID of schema-name

200 OK

a2_instance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Update operation of resource: objects

a2_objects_schema

objectsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Create operation of resource: objects

a2_objects_schema

objectsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Delete operation of resource: objects

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Retrieve operation of resource: objects

200 OK

a2_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Update operation of resource: object

a2_object_schema

objectbody object

object-list-name: string

in path

ID of object-list-name

Request Content-Types: application/json

Request Example

{
  "oid": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Create operation of resource: object

a2_object_schema

objectbody object

object-list-name: string

in path

ID of object-list-name

Request Content-Types: application/json

Request Example

{
  "oid": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Delete operation of resource: object

object-list-name: string

in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Retrieve operation of resource: object

object-list-name: string

in path

ID of object-list-name

200 OK

a2_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "oid": "string"
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Update operation of resource: objects

a2_objects_schema

objectsbody object

object-list-name: string

in path

ID of object-list-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Create operation of resource: objects

a2_objects_schema

objectsbody object

object-list-name: string

in path

ID of object-list-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Delete operation of resource: objects

object-list-name: string

in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Retrieve operation of resource: objects

object-list-name: string

in path

ID of object-list-name

200 OK

a2_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Update operation of resource: object

a2_object_schema

objectbody object

object-list-name: string

in path

ID of object-list-name

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "oid": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Create operation of resource: object

a2_object_schema

objectbody object

object-list-name: string

in path

ID of object-list-name

oid: string

in path

ID of oid

Request Content-Types: application/json

Request Example

{
  "oid": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Delete operation of resource: object

object-list-name: string

in path

ID of object-list-name

oid: string

in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Retrieve operation of resource: object

object-list-name: string

in path

ID of object-list-name

oid: string

in path

ID of oid

200 OK

a2_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "oid": "string"
}

TRANSFERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Update operation of resource: transfers

a2_transfers_schema

transfersbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Create operation of resource: transfers

a2_transfers_schema

transfersbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Delete operation of resource: transfers

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Retrieve operation of resource: transfers

200 OK

a2_transfers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

TRANSFER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Update operation of resource: transfer

a2_transfer_schema

transferbody object

transfer-name: string

in path

ID of transfer-name

Request Content-Types: application/json

Request Example

{
  "retry": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Create operation of resource: transfer

a2_transfer_schema

transferbody object

transfer-name: string

in path

ID of transfer-name

Request Content-Types: application/json

Request Example

{
  "retry": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Delete operation of resource: transfer

transfer-name: string

in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Retrieve operation of resource: transfer

transfer-name: string

in path

ID of transfer-name

200 OK

a2_transfer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "retry": "integer",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

TRANSFER-SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Update operation of resource: transfer-schemas

a2_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string

in path

ID of transfer-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Create operation of resource: transfer-schemas

a2_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string

in path

ID of transfer-name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Delete operation of resource: transfer-schemas

transfer-name: string

in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Retrieve operation of resource: transfer-schemas

transfer-name: string

in path

ID of transfer-name

200 OK

a2_transfer-schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}

TRANSFER-SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Update operation of resource: transfer-schema

a2_transfer-schema_schema

transfer-schemabody object

transfer-name: string

in path

ID of transfer-name

schema-name: string

in path

ID of schema-name

Request Content-Types: application/json

Request Example

{
  "schema-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Create operation of resource: transfer-schema

a2_transfer-schema_schema

transfer-schemabody object

transfer-name: string

in path

ID of transfer-name

schema-name: string

in path

ID of schema-name

Request Content-Types: application/json

Request Example

{
  "schema-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Delete operation of resource: transfer-schema

transfer-name: string

in path

ID of transfer-name

schema-name: string

in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Retrieve operation of resource: transfer-schema

transfer-name: string

in path

ID of transfer-name

schema-name: string

in path

ID of schema-name

200 OK

a2_transfer-schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "schema-name": "string"
}

DEFAULT-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Update operation of resource: default-community-maps

a2_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Create operation of resource: default-community-maps

a2_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Delete operation of resource: default-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Retrieve operation of resource: default-community-maps

200 OK

a2_default-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

DEFAULT-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Update operation of resource: default-community-map

a2_default-community-map_schema

default-community-mapbody object

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Create operation of resource: default-community-map

a2_default-community-map_schema

default-community-mapbody object

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Delete operation of resource: default-community-map

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Retrieve operation of resource: default-community-map

community-name: string

in path

ID of community-name

200 OK

a2_default-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

OVERLOAD-CONTROL - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Update operation of resource: overload-control

a2_overload-control_schema

overload-controlbody object

Request Content-Types: application/json

Request Example

{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Create operation of resource: overload-control

a2_overload-control_schema

overload-controlbody object

Request Content-Types: application/json

Request Example

{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Delete operation of resource: overload-control

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Retrieve operation of resource: overload-control

200 OK

a2_overload-control_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

TIMEOUTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Update operation of resource: timeouts

a2_timeouts_schema

timeoutsbody object

Request Content-Types: application/json

Request Example

{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Create operation of resource: timeouts

a2_timeouts_schema

timeoutsbody object

Request Content-Types: application/json

Request Example

{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Delete operation of resource: timeouts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Retrieve operation of resource: timeouts

200 OK

a2_timeouts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

USERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Update operation of resource: users

a2_users_schema

usersbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Create operation of resource: users

a2_users_schema

usersbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Delete operation of resource: users

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Retrieve operation of resource: users

200 OK

a2_users_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

USER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Update operation of resource: user

a2_user_schema

userbody object

user-name: string

in path

ID of user-name

Request Content-Types: application/json

Request Example

{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Create operation of resource: user

a2_user_schema

userbody object

user-name: string

in path

ID of user-name

Request Content-Types: application/json

Request Example

{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Delete operation of resource: user

user-name: string

in path

ID of user-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Retrieve operation of resource: user

user-name: string

in path

ID of user-name

200 OK

a2_user_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

VRFS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Update operation of resource: vrfs

a2_vrfs_schema

vrfsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Create operation of resource: vrfs

a2_vrfs_schema

vrfsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Retrieve operation of resource: vrfs

200 OK

a2_vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Update operation of resource: vrf

a2_vrf_schema

vrfbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Create operation of resource: vrf

a2_vrf_schema

vrfbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Delete operation of resource: vrf

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Retrieve operation of resource: vrf

in path

ID of name

200 OK

a2_vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "name": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Update operation of resource: trap-hosts

a2_trap-hosts_schema

trap-hostsbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },      : { PUT        POST       DELETE      GET      
      
        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Create operation of resource: trap-hosts

a2_trap-hosts_schema

trap-hostsbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },      : { PUT        POST       DELETE      GET      
      
        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Delete operation of resource: trap-hosts

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Retrieve operation of resource: trap-hosts

in path

ID of name

200 OK

a2_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },      : { PUT        POST       DELETE      GET      
      
        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a2_trap-host_schema

trap-hostbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a2_trap-host_schema

trap-hostbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

a2_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a2_encrypted-user-communities_schema

encrypted-user-communitiesbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a2_encrypted-user-communities_schema

encrypted-user-communitiesbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

a2_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a2_encrypted-user-community_schema

encrypted-user-communitybody object

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a2_encrypted-user-community_schema

encrypted-user-communitybody object

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

a2_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a2_inform-host_schema

inform-hostbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a2_inform-host_schema

inform-hostbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

a2_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a2_inform-user-communities_schema

inform-user-communitiesbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a2_inform-user-communities_schema

inform-user-communitiesbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

a2_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a2_inform-user-community_schema

inform-user-communitybody object

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a2_inform-user-community_schema

inform-user-communitybody object

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

a2_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a2_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a2_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

a2_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a2_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a2_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

a2_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a2_default-user-communities_schema

default-user-communitiesbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a2_default-user-communities_schema

default-user-communitiesbody object

in path

ID of name

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

in path

ID of name

ip-address: string

in path

ID of ip-address

200 OK

a2_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a2_default-user-community_schema

default-user-communitybody object

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a2_default-user-community_schema

default-user-communitybody object

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

in path

ID of name

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

a2_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Update operation of resource: contexts

a2_contexts_schema

contextsbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Create operation of resource: contexts

a2_contexts_schema

contextsbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Delete operation of resource: contexts

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Retrieve operation of resource: contexts

in path

ID of name

200 OK

a2_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Update operation of resource: context

a2_context_schema

contextbody object

in path

ID of name

context-name: string

in path

ID of context-name

Request Content-Types: application/json

Request Example

{
  "context-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Create operation of resource: context

a2_context_schema

contextbody object

in path

ID of name

context-name: string

in path

ID of context-name

Request Content-Types: application/json

Request Example

{
  "context-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Delete operation of resource: context

in path

ID of name

context-name: string

in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Retrieve operation of resource: context

in path

ID of name

context-name: string

in path

ID of context-name

200 OK

a2_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "context-name": "string"
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Update operation of resource: context-mappings

a2_context-mappings_schema

context-mappingsbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Create operation of resource: context-mappings

a2_context-mappings_schema

context-mappingsbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Delete operation of resource: context-mappings

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Retrieve operation of resource: context-mappings

in path

ID of name

200 OK

a2_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a2_context-mapping_schema

context-mappingbody object

in path

ID of name

context-mapping-name: string

in path

ID of context-mapping-name

Request Content-Types: application/json

Request Example

{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a2_context-mapping_schema

context-mappingbody object

in path

ID of name

context-mapping-name: string

in path

ID of context-mapping-name

Request Content-Types: application/json

Request Example

{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

in path

ID of name

context-mapping-name: string

in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

in path

ID of name

context-mapping-name: string

in path

ID of context-mapping-name

200 OK

a2_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

GROUPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Update operation of resource: groups

a2_groups_schema

groupsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Create operation of resource: groups

a2_groups_schema

groupsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Delete operation of resource: groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Retrieve operation of resource: groups

200 OK

a2_groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

GROUP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Update operation of resource: group

a2_group_schema

groupbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Create operation of resource: group

a2_group_schema

groupbody object

in path

ID of name

Request Content-Types: application/json

Request Example

{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Delete operation of resource: group

in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Retrieve operation of resource: group

in path

ID of name

200 OK

a2_group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Update operation of resource: trap-hosts

a2_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },      : { PUT        POST       DELETE      GET      
      
        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Create operation of resource: trap-hosts

a2_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },      : { PUT        POST       DELETE      GET      
      
        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Delete operation of resource: trap-hosts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Retrieve operation of resource: trap-hosts

200 OK

a2_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },      : { PUT        POST       DELETE      GET      
      
        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },        : { PUT          POST         DELETE        GET        
        
          : [ PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",      : { PUT        POST       DELETE      GET      
      
        : [ PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a2_trap-host_schema

trap-hostbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a2_trap-host_schema

trap-hostbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

ip-address: string

in path

ID of ip-address

200 OK

a2_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },    : { PUT      POST     DELETE    GET    
    
      : [ PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a2_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a2_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

ip-address: string

in path

ID of ip-address

200 OK

a2_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a2_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a2_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

a2_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a2_inform-host_schema

inform-hostbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a2_inform-host_schema

inform-hostbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

ip-address: string

in path

ID of ip-address

200 OK

a2_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },  : { PUT    POST   DELETE  GET  
  
    : [ PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a2_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a2_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

ip-address: string

in path

ID of ip-address

200 OK

a2_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a2_inform-user-community_schema

inform-user-communitybody object

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a2_inform-user-community_schema

inform-user-communitybody object

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

a2_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a2_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a2_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

ip-address: string

in path

ID of ip-address

200 OK

a2_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a2_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a2_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

a2_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a2_default-user-communities_schema

default-user-communitiesbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a2_default-user-communities_schema

default-user-communitiesbody object

ip-address: string

in path

ID of ip-address

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

ip-address: string

in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

ip-address: string

in path

ID of ip-address

200 OK

a2_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a2_default-user-community_schema

default-user-communitybody object

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a2_default-user-community_schema

default-user-communitybody object

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

Request Content-Types: application/json

Request Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

ip-address: string

in path

ID of ip-address

community-name: string

in path

ID of community-name

200 OK

a2_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Update operation of resource: contexts

a2_contexts_schema

contextsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Create operation of resource: contexts

a2_contexts_schema

contextsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Delete operation of resource: contexts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Retrieve operation of resource: contexts

200 OK

a2_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Update operation of resource: context

a2_context_schema

contextbody object

context-name: string

in path

ID of context-name

Request Content-Types: application/json

Request Example

{
  "context-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Create operation of resource: context

a2_context_schema

contextbody object

context-name: string

in path

ID of context-name

Request Content-Types: application/json

Request Example

{
  "context-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Delete operation of resource: context

context-name: string

in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Retrieve operation of resource: context

context-name: string

in path

ID of context-name

200 OK

a2_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "context-name": "string"
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Update operation of resource: context-mappings

a2_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Create operation of resource: context-mappings

a2_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json

Request Example

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Delete operation of resource: context-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Retrieve operation of resource: context-mappings

200 OK

a2_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{  : [ PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a2_context-mapping_schema

context-mappingbody object

context-mapping-name: string

in path

ID of context-mapping-name

Request Content-Types: application/json

Request Example

{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a2_context-mapping_schema

context-mappingbody object

context-mapping-name: string

in path

ID of context-mapping-name

Request Content-Types: application/json

Request Example

{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

context-mapping-name: string

in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

context-mapping-name: string

in path

ID of context-mapping-name

200 OK

a2_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

MIB - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:mib/

Update operation of resource: mib

a2_mib_schema

mibbody object

Request Content-Types: application/json

Request Example

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Create

POST Cisco-IOS-XR-snmp-agent-cfg:mib/

Create operation of resource: mib

a2_mib_schema

mibbody object

Request Content-Types: application/json

Request Example

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:mib/

Delete operation of resource: mib

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:mib/

Retrieve operation of resource: mib

200 OK

a2_mib_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

Response Example (200 OK)

Schema Definitions

AF-TABLE:

Common node of vrf, global-af

afs: object: VRF address family configuration
af: object[] VRF address family configuration object af-name: string ipv4, ipv6 Address family create: null VRF configuration for a particular address family topology-name: string Topology name saf-name: string unicast, multicast, flow-spec Sub-Address family

Example

{
  "afs": {
    "af": [
      {
        "af-name": "string",
        "create": [ null ],
        "topology-name": "string",
        "saf-name": "string"
      }
    ]
  }
}

vrfs_schema:

Set of VRFs configured under a VRF group

vrf: object[]: VRF configuration
object vrf-name: string VRF name

Example

{
  "vrf": [
    {
      "vrf-name": "string"
    }
  ]
}

vrf_schema:

vrf-name: string: VRF name

Example

{
  "vrf-name": "string"
}

vpn-id_schema:

VPN-ID for the VRF

vpn-oui: integer: OUI of VPNID OUI
range:"0..16777215"
vpn-index: integer: Index of VPNID Index
range:"0..4294967295"

Example

{
  "vpn-oui": "integer",
  "vpn-index": "integer"
}

afs_schema:

VRF address family configuration

af: object[]: VRF address family configuration
object af-name: string ipv4, ipv6 Address family create: null VRF configuration for a particular address family topology-name: string Topology name saf-name: string unicast, multicast, flow-spec Sub-Address family

Example

{
  "af": [
    {
      "af-name": "string",
      "create": [ null ],
      "topology-name": "string",
      "saf-name": "string"
    }
  ]
}

af_schema:

af-name: string ipv4, ipv6: Address family
create: null: VRF configuration for a particular address family
topology-name: string: Topology name
saf-name: string unicast, multicast, flow-spec: Sub-Address family

Example

{
  "af-name": "string",
  "create": [ null ],
  "topology-name": "string",
  "saf-name": "string"
}

srlg_schema:

srlg

inherit-nodes: object: Set of inherit nodes configured with SRLG
inherit-node: object[] Inherit node configurations object enable: null Enable SRLG inherit node inherit-node-values: object Set of SRLG values configured under an inherit node inherit-node-value: object[] Inherit node SRLG value with attributes object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" inherit-node-name: string The inherit node name
interfaces: object: Set of interfaces configured with SRLG
interface: object[] Interface configurations object interface-group: object Group configuration for an interface group-names: object Set of group name under an interface group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority enable: null Enable SRLG interface group submode enable: null Enable SRLG interface values: object SRLG Value configuration for an interface value: object[] SRLG value data object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" interface-name: string Interface name include-optical: object Include optical configuration for an interface priority: string critical, high, default, low, very-low Priority for optical domain values enable: null Enable SRLG interface include optical interface-srlg-names: object SRLG Name configuration for an interface interface-srlg-name: object[] SRLG name data object srlg-name: string SRLG name
enable: null: Enable SRLG
srlg-names: object: Set of SRLG name configuration
srlg-name: object[] SRLG name configuration object srlg-name: string SRLG name srlg-value: integer SRLG value range:"0..4294967295"
groups: object: Set of groups configured with SRLG
group: object[] Group configurations object group-name: string Group name enable: null Enable SRLG group group-values: object Set of SRLG values configured under a group group-value: object[] Group SRLG values with attribute object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "inherit-nodes": {
    "inherit-node": [
      {
        "enable": [ null ],
        "inherit-node-values": {
          "inherit-node-value": [
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "inherit-node-name": "string"
      }
    ]
  },
  "interfaces": {
    "interface": [
      {
        "interface-group": {
          "group-names": {
            "group-name": [
              {
                "group-name-index": "integer",
                "group-name": "string",
                "srlg-priority": "string"
              }
            ]
          },
          "enable": [ null ]
        },
        "enable": [ null ],
        "values": {
          "value": [
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "interface-name": "string",
        "include-optical": {
          "priority": "string",
          "enable": [ null ]
        },
        "interface-srlg-names": {
          "interface-srlg-name": [
            {
              "srlg-name": "string"
            }
          ]
        }
      }
    ]
  },
  "enable": [ null ],
  "srlg-names": {
    "srlg-name": [
      {
        "srlg-name": "string",
        "srlg-value": "integer"
      }
    ]
  },
  "groups": {
    "group": [
      {
        "group-name": "string",
        "enable": [ null ],
        "group-values": {
          "group-value": [
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        }
      }
    ]
  }
}

interfaces_schema:

Set of interfaces configured with SRLG

interface: object[]: Interface configurations
object interface-group: object Group configuration for an interface group-names: object Set of group name under an interface group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority enable: null Enable SRLG interface group submode enable: null Enable SRLG interface values: object SRLG Value configuration for an interface value: object[] SRLG value data object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" interface-name: string Interface name include-optical: object Include optical configuration for an interface priority: string critical, high, default, low, very-low Priority for optical domain values enable: null Enable SRLG interface include optical interface-srlg-names: object SRLG Name configuration for an interface interface-srlg-name: object[] SRLG name data object srlg-name: string SRLG name

Example

{
  "interface": [
    {
      "interface-group": {
        "group-names": {
          "group-name": [
            {
              "group-name-index": "integer",
              "group-name": "string",
              "srlg-priority": "string"
            }
          ]
        },
        "enable": [ null ]
      },
      "enable": [ null ],
      "values": {
        "value": [
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "interface-name": "string",
      "include-optical": {
        "priority": "string",
        "enable": [ null ]
      },
      "interface-srlg-names": {
        "interface-srlg-name": [
          {
            "srlg-name": "string"
          }
        ]
      }
    }
  ]
}

interface_schema:

interface-group: object: Group configuration for an interface
group-names: object Set of group name under an interface group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority enable: null Enable SRLG interface group submode
enable: null: Enable SRLG interface
values: object: SRLG Value configuration for an interface
value: object[] SRLG value data object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"
interface-name: string: Interface name
include-optical: object: Include optical configuration for an interface
priority: string critical, high, default, low, very-low Priority for optical domain values enable: null Enable SRLG interface include optical
interface-srlg-names: object: SRLG Name configuration for an interface
interface-srlg-name: object[] SRLG name data object srlg-name: string SRLG name

Example

{
  "interface-group": {
    "group-names": {
      "group-name": [
        {
          "group-name-index": "integer",
          "group-name": "string",
          "srlg-priority": "string"
        }
      ]
    },
    "enable": [ null ]
  },
  "enable": [ null ],
  "values": {
    "value": [
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "interface-name": "string",
  "include-optical": {
    "priority": "string",
    "enable": [ null ]
  },
  "interface-srlg-names": {
    "interface-srlg-name": [
      {
        "srlg-name": "string"
      }
    ]
  }
}

include-optical_schema:

Include optical configuration for an interface

priority: string critical, high, default, low, very-low: Priority for optical domain values
enable: null: Enable SRLG interface include optical

Example

{
  "priority": "string",
  "enable": [ null ]
}

interface-group_schema:

Group configuration for an interface

group-names: object: Set of group name under an interface
group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority
enable: null: Enable SRLG interface group submode

Example

{
  "group-names": {
    "group-name": [
      {
        "group-name-index": "integer",
        "group-name": "string",
        "srlg-priority": "string"
      }
    ]
  },
  "enable": [ null ]
}

group-names_schema:

Set of group name under an interface

group-name: object[]: Group name included under interface
object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority

Example

{
  "group-name": [
    {
      "group-name-index": "integer",
      "group-name": "string",
      "srlg-priority": "string"
    }
  ]
}

group-name_schema:

group-name-index: integer: Group name index
group-name: string: Group name
srlg-priority: string critical, high, default, low, very-low: SRLG priority

Example

{
  "group-name-index": "integer",
  "group-name": "string",
  "srlg-priority": "string"
}

values_schema:

SRLG Value configuration for an interface

value: object[]: SRLG value data
object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "value": [
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

value_schema:

srlg-priority: string critical, high, default, low, very-low: SRLG priority
srlg-index: integer: SRLG index
range:"1..65535"
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

interface-srlg-names_schema:

SRLG Name configuration for an interface

interface-srlg-name: object[]: SRLG name data
object srlg-name: string SRLG name

Example

{
  "interface-srlg-name": [
    {
      "srlg-name": "string"
    }
  ]
}

interface-srlg-name_schema:

srlg-name: string: SRLG name

Example

{
  "srlg-name": "string"
}

srlg-names_schema:

Set of SRLG name configuration

srlg-name: object[]: SRLG name configuration
object srlg-name: string SRLG name srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "srlg-name": [
    {
      "srlg-name": "string",
      "srlg-value": "integer"
    }
  ]
}

srlg-name_schema:

srlg-name: string: SRLG name
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-name": "string",
  "srlg-value": "integer"
}

groups_schema:

Set of groups configured with SRLG

group: object[]: Group configurations
object group-name: string Group name enable: null Enable SRLG group group-values: object Set of SRLG values configured under a group group-value: object[] Group SRLG values with attribute object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "group": [
    {
      "group-name": "string",
      "enable": [ null ],
      "group-values": {
        "group-value": [
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      }
    }
  ]
}

group_schema:

group-name: string: Group name
enable: null: Enable SRLG group
group-values: object: Set of SRLG values configured under a group
group-value: object[] Group SRLG values with attribute object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "group-name": "string",
  "enable": [ null ],
  "group-values": {
    "group-value": [
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  }
}

group-values_schema:

Set of SRLG values configured under a group

group-value: object[]: Group SRLG values with attribute
object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "group-value": [
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

group-value_schema:

srlg-priority: string critical, high, default, low, very-low: SRLG priority
srlg-index: integer: SRLG index
range:"1..65535"
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

inherit-nodes_schema:

Set of inherit nodes configured with SRLG

inherit-node: object[]: Inherit node configurations
object enable: null Enable SRLG inherit node inherit-node-values: object Set of SRLG values configured under an inherit node inherit-node-value: object[] Inherit node SRLG value with attributes object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" inherit-node-name: string The inherit node name

Example

{
  "inherit-node": [
    {
      "enable": [ null ],
      "inherit-node-values": {
        "inherit-node-value": [
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "inherit-node-name": "string"
    }
  ]
}

inherit-node_schema:

enable: null: Enable SRLG inherit node
inherit-node-values: object: Set of SRLG values configured under an inherit node
inherit-node-value: object[] Inherit node SRLG value with attributes object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"
inherit-node-name: string: The inherit node name

Example

{
  "enable": [ null ],
  "inherit-node-values": {
    "inherit-node-value": [
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "inherit-node-name": "string"
}

inherit-node-values_schema:

Set of SRLG values configured under an inherit node

inherit-node-value: object[]: Inherit node SRLG value with attributes
object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "inherit-node-value": [
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

inherit-node-value_schema:

srlg-priority: string critical, high, default, low, very-low: SRLG priority
srlg-index: integer: SRLG index
range:"1..65535"
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

vrf-groups_schema:

vrf groups

vrf-group: object[]: VRF group configuration
object enable: null Enable VRF group vrfs: object Set of VRFs configured under a VRF group vrf: object[] VRF configuration object vrf-name: string VRF name vrf-group-name: string VRF group name

Example

{
  "vrf-group": [
    {
      "enable": [ null ],
      "vrfs": {
        "vrf": [
          {
            "vrf-name": "string"
          }
        ]
      },
      "vrf-group-name": "string"
    }
  ]
}

vrf-group_schema:

enable: null: Enable VRF group
vrfs: object: Set of VRFs configured under a VRF group
vrf: object[] VRF configuration object vrf-name: string VRF name
vrf-group-name: string: VRF group name

Example

{
  "enable": [ null ],
  "vrfs": {
    "vrf": [
      {
        "vrf-name": "string"
      }
    ]
  },
  "vrf-group-name": "string"
}

selective-vrf-download_schema:

selective vrf download

disable: null: Disable selective VRF download

Example

{
  "disable": [ null ]
}

a1_vrfs_schema:

Set of VRFs configured under a VRF group

vrf: object[]: VRF configuration
object vrf-name: string VRF name

Example

{
  "vrf": [
    {
      "vrf-name": "string"
    }
  ]
}

a1_vrf_schema:

vrf-name: string: VRF name

Example

{
  "vrf-name": "string"
}

a1_vpn-id_schema:

VPN-ID for the VRF

vpn-oui: integer: OUI of VPNID OUI
range:"0..16777215"
vpn-index: integer: Index of VPNID Index
range:"0..4294967295"

Example

{
  "vpn-oui": "integer",
  "vpn-index": "integer"
}

a1_afs_schema:

Per-address-family and topology configuration

af-topology-name: object[]: The presence of this object enables the givenaddress-family and topology on the interface.
object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family topology-name: string Topology name
af: object[]: The presence of this object enables the givenaddress-family and topology on the interface.
object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family

Example

{
  "af-topology-name": [
    {
      "af-name": "string",
      "saf-name": "string",
      "topology-name": "string"
    }
  ],
  "af": [
    {
      "af-name": "string",
      "saf-name": "string"
    }
  ]
}

a1_af_schema:

af-name: string ipv4, ipv6: Address-family
saf-name: string unicast, multicast, flow-spec: Sub-address-family

Example

{
  "af-name": "string",
  "saf-name": "string"
}

a1_srlg_schema:

srlg

inherit-nodes: object: Set of inherit nodes configured with SRLG
inherit-node: object[] Inherit node configurations object enable: null Enable SRLG inherit node inherit-node-values: object Set of SRLG values configured under an inherit node inherit-node-value: object[] Inherit node SRLG value with attributes object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" inherit-node-name: string The inherit node name
interfaces: object: Set of interfaces configured with SRLG
interface: object[] Interface configurations object interface-group: object Group configuration for an interface group-names: object Set of group name under an interface group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority enable: null Enable SRLG interface group submode enable: null Enable SRLG interface values: object SRLG Value configuration for an interface value: object[] SRLG value data object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" interface-name: string Interface name include-optical: object Include optical configuration for an interface priority: string critical, high, default, low, very-low Priority for optical domain values enable: null Enable SRLG interface include optical interface-srlg-names: object SRLG Name configuration for an interface interface-srlg-name: object[] SRLG name data object srlg-name: string SRLG name
enable: null: Enable SRLG
srlg-names: object: Set of SRLG name configuration
srlg-name: object[] SRLG name configuration object srlg-name: string SRLG name srlg-value: integer SRLG value range:"0..4294967295"
groups: object: Set of groups configured with SRLG
group: object[] Group configurations object group-name: string Group name enable: null Enable SRLG group group-values: object Set of SRLG values configured under a group group-value: object[] Group SRLG values with attribute object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "inherit-nodes": {
    "inherit-node": [
      {
        "enable": [ null ],
        "inherit-node-values": {
          "inherit-node-value": [
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "inherit-node-name": "string"
      }
    ]
  },
  "interfaces": {
    "interface": [
      {
        "interface-group": {
          "group-names": {
            "group-name": [
              {
                "group-name-index": "integer",
                "group-name": "string",
                "srlg-priority": "string"
              }
            ]
          },
          "enable": [ null ]
        },
        "enable": [ null ],
        "values": {
          "value": [
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "interface-name": "string",
        "include-optical": {
          "priority": "string",
          "enable": [ null ]
        },
        "interface-srlg-names": {
          "interface-srlg-name": [
            {
              "srlg-name": "string"
            }
          ]
        }
      }
    ]
  },
  "enable": [ null ],
  "srlg-names": {
    "srlg-name": [
      {
        "srlg-name": "string",
        "srlg-value": "integer"
      }
    ]
  },
  "groups": {
    "group": [
      {
        "group-name": "string",
        "enable": [ null ],
        "group-values": {
          "group-value": [
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        }
      }
    ]
  }
}

a1_interfaces_schema:

Set of interfaces configured with SRLG

interface: object[]: Interface configurations
object interface-group: object Group configuration for an interface group-names: object Set of group name under an interface group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority enable: null Enable SRLG interface group submode enable: null Enable SRLG interface values: object SRLG Value configuration for an interface value: object[] SRLG value data object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" interface-name: string Interface name include-optical: object Include optical configuration for an interface priority: string critical, high, default, low, very-low Priority for optical domain values enable: null Enable SRLG interface include optical interface-srlg-names: object SRLG Name configuration for an interface interface-srlg-name: object[] SRLG name data object srlg-name: string SRLG name

Example

{
  "interface": [
    {
      "interface-group": {
        "group-names": {
          "group-name": [
            {
              "group-name-index": "integer",
              "group-name": "string",
              "srlg-priority": "string"
            }
          ]
        },
        "enable": [ null ]
      },
      "enable": [ null ],
      "values": {
        "value": [
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "interface-name": "string",
      "include-optical": {
        "priority": "string",
        "enable": [ null ]
      },
      "interface-srlg-names": {
        "interface-srlg-name": [
          {
            "srlg-name": "string"
          }
        ]
      }
    }
  ]
}

a1_interface_schema:

interface-group: object: Group configuration for an interface
group-names: object Set of group name under an interface group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority enable: null Enable SRLG interface group submode
enable: null: Enable SRLG interface
values: object: SRLG Value configuration for an interface
value: object[] SRLG value data object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"
interface-name: string: Interface name
include-optical: object: Include optical configuration for an interface
priority: string critical, high, default, low, very-low Priority for optical domain values enable: null Enable SRLG interface include optical
interface-srlg-names: object: SRLG Name configuration for an interface
interface-srlg-name: object[] SRLG name data object srlg-name: string SRLG name

Example

{
  "interface-group": {
    "group-names": {
      "group-name": [
        {
          "group-name-index": "integer",
          "group-name": "string",
          "srlg-priority": "string"
        }
      ]
    },
    "enable": [ null ]
  },
  "enable": [ null ],
  "values": {
    "value": [
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "interface-name": "string",
  "include-optical": {
    "priority": "string",
    "enable": [ null ]
  },
  "interface-srlg-names": {
    "interface-srlg-name": [
      {
        "srlg-name": "string"
      }
    ]
  }
}

a1_include-optical_schema:

Include optical configuration for an interface

priority: string critical, high, default, low, very-low: Priority for optical domain values
enable: null: Enable SRLG interface include optical

Example

{
  "priority": "string",
  "enable": [ null ]
}

a1_interface-group_schema:

Group configuration for an interface

group-names: object: Set of group name under an interface
group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority
enable: null: Enable SRLG interface group submode

Example

{
  "group-names": {
    "group-name": [
      {
        "group-name-index": "integer",
        "group-name": "string",
        "srlg-priority": "string"
      }
    ]
  },
  "enable": [ null ]
}

a1_group-names_schema:

Set of group name under an interface

group-name: object[]: Group name included under interface
object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority

Example

{
  "group-name": [
    {
      "group-name-index": "integer",
      "group-name": "string",
      "srlg-priority": "string"
    }
  ]
}

a1_group-name_schema:

group-name-index: integer: Group name index
group-name: string: Group name
srlg-priority: string critical, high, default, low, very-low: SRLG priority

Example

{
  "group-name-index": "integer",
  "group-name": "string",
  "srlg-priority": "string"
}

a1_values_schema:

SRLG Value configuration for an interface

value: object[]: SRLG value data
object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "value": [
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

a1_value_schema:

srlg-priority: string critical, high, default, low, very-low: SRLG priority
srlg-index: integer: SRLG index
range:"1..65535"
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

a1_interface-srlg-names_schema:

SRLG Name configuration for an interface

interface-srlg-name: object[]: SRLG name data
object srlg-name: string SRLG name

Example

{
  "interface-srlg-name": [
    {
      "srlg-name": "string"
    }
  ]
}

a1_interface-srlg-name_schema:

srlg-name: string: SRLG name

Example

{
  "srlg-name": "string"
}

a1_srlg-names_schema:

Set of SRLG name configuration

srlg-name: object[]: SRLG name configuration
object srlg-name: string SRLG name srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "srlg-name": [
    {
      "srlg-name": "string",
      "srlg-value": "integer"
    }
  ]
}

a1_srlg-name_schema:

srlg-name: string: SRLG name
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-name": "string",
  "srlg-value": "integer"
}

a1_groups_schema:

Set of groups configured with SRLG

group: object[]: Group configurations
object group-name: string Group name enable: null Enable SRLG group group-values: object Set of SRLG values configured under a group group-value: object[] Group SRLG values with attribute object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "group": [
    {
      "group-name": "string",
      "enable": [ null ],
      "group-values": {
        "group-value": [
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      }
    }
  ]
}

a1_group_schema:

group-name: string: Group name
enable: null: Enable SRLG group
group-values: object: Set of SRLG values configured under a group
group-value: object[] Group SRLG values with attribute object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "group-name": "string",
  "enable": [ null ],
  "group-values": {
    "group-value": [
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  }
}

a1_group-values_schema:

Set of SRLG values configured under a group

group-value: object[]: Group SRLG values with attribute
object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "group-value": [
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

a1_group-value_schema:

srlg-priority: string critical, high, default, low, very-low: SRLG priority
srlg-index: integer: SRLG index
range:"1..65535"
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

a1_inherit-nodes_schema:

Set of inherit nodes configured with SRLG

inherit-node: object[]: Inherit node configurations
object enable: null Enable SRLG inherit node inherit-node-values: object Set of SRLG values configured under an inherit node inherit-node-value: object[] Inherit node SRLG value with attributes object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" inherit-node-name: string The inherit node name

Example

{
  "inherit-node": [
    {
      "enable": [ null ],
      "inherit-node-values": {
        "inherit-node-value": [
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "inherit-node-name": "string"
    }
  ]
}

a1_inherit-node_schema:

enable: null: Enable SRLG inherit node
inherit-node-values: object: Set of SRLG values configured under an inherit node
inherit-node-value: object[] Inherit node SRLG value with attributes object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"
inherit-node-name: string: The inherit node name

Example

{
  "enable": [ null ],
  "inherit-node-values": {
    "inherit-node-value": [
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "inherit-node-name": "string"
}

a1_inherit-node-values_schema:

Set of SRLG values configured under an inherit node

inherit-node-value: object[]: Inherit node SRLG value with attributes
object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "inherit-node-value": [
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

a1_inherit-node-value_schema:

srlg-priority: string critical, high, default, low, very-low: SRLG priority
srlg-index: integer: SRLG index
range:"1..65535"
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

a1_vrf-groups_schema:

vrf groups

vrf-group: object[]: VRF group configuration
object enable: null Enable VRF group vrfs: object Set of VRFs configured under a VRF group vrf: object[] VRF configuration object vrf-name: string VRF name vrf-group-name: string VRF group name

Example

{
  "vrf-group": [
    {
      "enable": [ null ],
      "vrfs": {
        "vrf": [
          {
            "vrf-name": "string"
          }
        ]
      },
      "vrf-group-name": "string"
    }
  ]
}

a1_vrf-group_schema:

enable: null: Enable VRF group
vrfs: object: Set of VRFs configured under a VRF group
vrf: object[] VRF configuration object vrf-name: string VRF name
vrf-group-name: string: VRF group name

Example

{
  "enable": [ null ],
  "vrfs": {
    "vrf": [
      {
        "vrf-name": "string"
      }
    ]
  },
  "vrf-group-name": "string"
}

a1_selective-vrf-download_schema:

selective vrf download

disable: null: Disable selective VRF download

Example

{
  "disable": [ null ]
}

a1_global-interface-configuration_schema:

Global scoped configuration for interfaces

link-status: string default, disable, software-interfaces: Enable or disable link-status messages

Example

{
  "link-status": "string"
}

a1_interface-configurations_schema:

interface configurations

interface-configuration: object[]: The configuration for an interface
object dampening: object Whether this interface's state changes are dampened or not args: string default-values, specify-half-life, specify-all, specify-rp Dampening Arguments suppress-threshold: integer Suppress threshold range:"1..20000" half-life: integer Decay half life (in minutes) range:"1..45" units:"minute" suppress-time: integer Max suppress time (in minutes) range:"1..255" units:"minute" reuse-threshold: integer Reuse threshold range:"1..20000" restart-penalty: integer Restart penalty range:"0..20000" description: string The description of this interface secondary-admin-state: string normal, maintenance The secondary admin state of the interface interface-virtual: null The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface. link-status: null Enable interface and line-protocol state change alarms bandwidth: integer The bandwidth of the interface in kbps range:"0..4294967295" units:"kbit/s" mtus: object The MTU configuration for the interface mtu: object[] The MTU for the interface object owner: string The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback' mtu: integer The MTU value range:"64..65535" vrf: string Assign the interface to a VRF shutdown: null The existence of this configuration indicates the interface is shut down active: string Whether the interface is active or preconfigured encapsulation: object The encapsulation on the interface encapsulation: string The encapsulation - e.g. hdlc, ppp capsulation-options: integer The options for this capsulation, usually '0' interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport The mode in which an interface is running. The existence of this object causes the creation of the software subinterface. interface-name: string The name of the interface afs: object Per-address-family and topology configuration af-topology-name: object[] The presence of this object enables the givenaddress-family and topology on the interface. object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family topology-name: string Topology name af: object[] The presence of this object enables the givenaddress-family and topology on the interface. object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family

Example

{
  "interface-configuration": [
    {
      "dampening": {
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "description": "string",
      "secondary-admin-state": "string",
      "interface-virtual": [ null ],
      "link-status": [ null ],
      "bandwidth": "integer",
      "mtus": {
        "mtu": [
          {
            "owner": "string",
            "mtu": "integer"
          }
        ]
      },
      "vrf": "string",
      "shutdown": [ null ],
      "active": "string",
      "encapsulation": {
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      "interface-mode-non-physical": "string",
      "interface-name": "string",
      "afs": {
        "af-topology-name": [
          {
            "af-name": "string",
            "saf-name": "string",
            "topology-name": "string"
          }
        ],
        "af": [
          {
            "af-name": "string",
            "saf-name": "string"
          }
        ]
      }
    }
  ]
}

a1_interface-configuration_schema:

dampening: object: Whether this interface's state changes are dampened or not
args: string default-values, specify-half-life, specify-all, specify-rp Dampening Arguments suppress-threshold: integer Suppress threshold range:"1..20000" half-life: integer Decay half life (in minutes) range:"1..45" units:"minute" suppress-time: integer Max suppress time (in minutes) range:"1..255" units:"minute" reuse-threshold: integer Reuse threshold range:"1..20000" restart-penalty: integer Restart penalty range:"0..20000"
description: string: The description of this interface
secondary-admin-state: string normal, maintenance: The secondary admin state of the interface
interface-virtual: null: The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.
link-status: null: Enable interface and line-protocol state change alarms
bandwidth: integer: The bandwidth of the interface in kbps
range:"0..4294967295" units:"kbit/s"
mtus: object: The MTU configuration for the interface
mtu: object[] The MTU for the interface object owner: string The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback' mtu: integer The MTU value range:"64..65535"
vrf: string: Assign the interface to a VRF
shutdown: null: The existence of this configuration indicates the interface is shut down
active: string: Whether the interface is active or preconfigured
encapsulation: object: The encapsulation on the interface
encapsulation: string The encapsulation - e.g. hdlc, ppp capsulation-options: integer The options for this capsulation, usually '0'
interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport: The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.
interface-name: string: The name of the interface
afs: object: Per-address-family and topology configuration
af-topology-name: object[] The presence of this object enables the givenaddress-family and topology on the interface. object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family topology-name: string Topology name af: object[] The presence of this object enables the givenaddress-family and topology on the interface. object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family

Example

{
  "dampening": {
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "description": "string",
  "secondary-admin-state": "string",
  "interface-virtual": [ null ],
  "link-status": [ null ],
  "bandwidth": "integer",
  "mtus": {
    "mtu": [
      {
        "owner": "string",
        "mtu": "integer"
      }
    ]
  },
  "vrf": "string",
  "shutdown": [ null ],
  "active": "string",
  "encapsulation": {
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  "interface-mode-non-physical": "string",
  "interface-name": "string",
  "afs": {
    "af-topology-name": [
      {
        "af-name": "string",
        "saf-name": "string",
        "topology-name": "string"
      }
    ],
    "af": [
      {
        "af-name": "string",
        "saf-name": "string"
      }
    ]
  }
}

a1_dampening_schema:

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp: Dampening Arguments
suppress-threshold: integer: Suppress threshold
range:"1..20000"
half-life: integer: Decay half life (in minutes)
range:"1..45" units:"minute"
suppress-time: integer: Max suppress time (in minutes)
range:"1..255" units:"minute"
reuse-threshold: integer: Reuse threshold
range:"1..20000"
restart-penalty: integer: Restart penalty
range:"0..20000"

Example

{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}

a1_mtus_schema:

The MTU configuration for the interface

mtu: object[]: The MTU for the interface
object owner: string The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback' mtu: integer The MTU value range:"64..65535"

Example

{
  "mtu": [
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}

a1_mtu_schema:

owner: string: The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
mtu: integer: The MTU value
range:"64..65535"

Example

{
  "owner": "string",
  "mtu": "integer"
}

a1_encapsulation_schema:

The encapsulation on the interface

encapsulation: string: The encapsulation - e.g. hdlc, ppp
capsulation-options: integer: The options for this capsulation, usually '0'

Example

{
  "encapsulation": "string",
  "capsulation-options": "integer"
}

a1_af-topology-name_schema:

af-name: string ipv4, ipv6: Address-family
saf-name: string unicast, multicast, flow-spec: Sub-address-family
topology-name: string: Topology name

Example

{
  "af-name": "string",
  "saf-name": "string",
  "topology-name": "string"
}

a2_vrfs_schema:

SNMP VRF configuration commands

vrf: object[]: VRF name
CONTEXT-MAPPING-TABLE name: string VRF name

Example

{
  "vrf": [
    {
      "name": "string",
      "context-mappings": {
        "context-mapping": [
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

a2_vrf_schema:

CONTEXT-MAPPING-TABLE

name: string: VRF name

Example

{
  "name": "string",
  "context-mappings": {
    "context-mapping": [
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

a2_vpn-id_schema:

VPN-ID for the VRF

vpn-oui: integer: OUI of VPNID OUI
range:"0..16777215"
vpn-index: integer: Index of VPNID Index
range:"0..4294967295"

Example

{
  "vpn-oui": "integer",
  "vpn-index": "integer"
}

a2_afs_schema:

Per-address-family and topology configuration

af-topology-name: object[]: The presence of this object enables the givenaddress-family and topology on the interface.
object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family topology-name: string Topology name
af: object[]: The presence of this object enables the givenaddress-family and topology on the interface.
object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family

Example

{
  "af-topology-name": [
    {
      "af-name": "string",
      "saf-name": "string",
      "topology-name": "string"
    }
  ],
  "af": [
    {
      "af-name": "string",
      "saf-name": "string"
    }
  ]
}

a2_af_schema:

af-name: string ipv4, ipv6: Address-family
saf-name: string unicast, multicast, flow-spec: Sub-address-family

Example

{
  "af-name": "string",
  "saf-name": "string"
}

a2_srlg_schema:

srlg

inherit-nodes: object: Set of inherit nodes configured with SRLG
inherit-node: object[] Inherit node configurations object enable: null Enable SRLG inherit node inherit-node-values: object Set of SRLG values configured under an inherit node inherit-node-value: object[] Inherit node SRLG value with attributes object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" inherit-node-name: string The inherit node name
interfaces: object: Set of interfaces configured with SRLG
interface: object[] Interface configurations object interface-group: object Group configuration for an interface group-names: object Set of group name under an interface group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority enable: null Enable SRLG interface group submode enable: null Enable SRLG interface values: object SRLG Value configuration for an interface value: object[] SRLG value data object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" interface-name: string Interface name include-optical: object Include optical configuration for an interface priority: string critical, high, default, low, very-low Priority for optical domain values enable: null Enable SRLG interface include optical interface-srlg-names: object SRLG Name configuration for an interface interface-srlg-name: object[] SRLG name data object srlg-name: string SRLG name
enable: null: Enable SRLG
srlg-names: object: Set of SRLG name configuration
srlg-name: object[] SRLG name configuration object srlg-name: string SRLG name srlg-value: integer SRLG value range:"0..4294967295"
groups: object: Set of groups configured with SRLG
group: object[] Group configurations object group-name: string Group name enable: null Enable SRLG group group-values: object Set of SRLG values configured under a group group-value: object[] Group SRLG values with attribute object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "inherit-nodes": {
    "inherit-node": [
      {
        "enable": [ null ],
        "inherit-node-values": {
          "inherit-node-value": [
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "inherit-node-name": "string"
      }
    ]
  },
  "interfaces": {
    "interface": [
      {
        "interface-group": {
          "group-names": {
            "group-name": [
              {
                "group-name-index": "integer",
                "group-name": "string",
                "srlg-priority": "string"
              }
            ]
          },
          "enable": [ null ]
        },
        "enable": [ null ],
        "values": {
          "value": [
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        },
        "interface-name": "string",
        "include-optical": {
          "priority": "string",
          "enable": [ null ]
        },
        "interface-srlg-names": {
          "interface-srlg-name": [
            {
              "srlg-name": "string"
            }
          ]
        }
      }
    ]
  },
  "enable": [ null ],
  "srlg-names": {
    "srlg-name": [
      {
        "srlg-name": "string",
        "srlg-value": "integer"
      }
    ]
  },
  "groups": {
    "group": [
      {
        "group-name": "string",
        "enable": [ null ],
        "group-values": {
          "group-value": [
            {
              "srlg-priority": "string",
              "srlg-index": "integer",
              "srlg-value": "integer"
            }
          ]
        }
      }
    ]
  }
}

a2_interfaces_schema:

Set of interfaces configured with SRLG

interface: object[]: Interface configurations
object interface-group: object Group configuration for an interface group-names: object Set of group name under an interface group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority enable: null Enable SRLG interface group submode enable: null Enable SRLG interface values: object SRLG Value configuration for an interface value: object[] SRLG value data object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" interface-name: string Interface name include-optical: object Include optical configuration for an interface priority: string critical, high, default, low, very-low Priority for optical domain values enable: null Enable SRLG interface include optical interface-srlg-names: object SRLG Name configuration for an interface interface-srlg-name: object[] SRLG name data object srlg-name: string SRLG name

Example

{
  "interface": [
    {
      "interface-group": {
        "group-names": {
          "group-name": [
            {
              "group-name-index": "integer",
              "group-name": "string",
              "srlg-priority": "string"
            }
          ]
        },
        "enable": [ null ]
      },
      "enable": [ null ],
      "values": {
        "value": [
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "interface-name": "string",
      "include-optical": {
        "priority": "string",
        "enable": [ null ]
      },
      "interface-srlg-names": {
        "interface-srlg-name": [
          {
            "srlg-name": "string"
          }
        ]
      }
    }
  ]
}

a2_interface_schema:

interface-group: object: Group configuration for an interface
group-names: object Set of group name under an interface group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority enable: null Enable SRLG interface group submode
enable: null: Enable SRLG interface
values: object: SRLG Value configuration for an interface
value: object[] SRLG value data object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"
interface-name: string: Interface name
include-optical: object: Include optical configuration for an interface
priority: string critical, high, default, low, very-low Priority for optical domain values enable: null Enable SRLG interface include optical
interface-srlg-names: object: SRLG Name configuration for an interface
interface-srlg-name: object[] SRLG name data object srlg-name: string SRLG name

Example

{
  "interface-group": {
    "group-names": {
      "group-name": [
        {
          "group-name-index": "integer",
          "group-name": "string",
          "srlg-priority": "string"
        }
      ]
    },
    "enable": [ null ]
  },
  "enable": [ null ],
  "values": {
    "value": [
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "interface-name": "string",
  "include-optical": {
    "priority": "string",
    "enable": [ null ]
  },
  "interface-srlg-names": {
    "interface-srlg-name": [
      {
        "srlg-name": "string"
      }
    ]
  }
}

a2_include-optical_schema:

Include optical configuration for an interface

priority: string critical, high, default, low, very-low: Priority for optical domain values
enable: null: Enable SRLG interface include optical

Example

{
  "priority": "string",
  "enable": [ null ]
}

a2_interface-group_schema:

Group configuration for an interface

group-names: object: Set of group name under an interface
group-name: object[] Group name included under interface object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority
enable: null: Enable SRLG interface group submode

Example

{
  "group-names": {
    "group-name": [
      {
        "group-name-index": "integer",
        "group-name": "string",
        "srlg-priority": "string"
      }
    ]
  },
  "enable": [ null ]
}

a2_group-names_schema:

Set of group name under an interface

group-name: object[]: Group name included under interface
object group-name-index: integer Group name index group-name: string Group name srlg-priority: string critical, high, default, low, very-low SRLG priority

Example

{
  "group-name": [
    {
      "group-name-index": "integer",
      "group-name": "string",
      "srlg-priority": "string"
    }
  ]
}

a2_group-name_schema:

group-name-index: integer: Group name index
group-name: string: Group name
srlg-priority: string critical, high, default, low, very-low: SRLG priority

Example

{
  "group-name-index": "integer",
  "group-name": "string",
  "srlg-priority": "string"
}

a2_values_schema:

SRLG Value configuration for an interface

value: object[]: SRLG value data
object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "value": [
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

a2_value_schema:

srlg-priority: string critical, high, default, low, very-low: SRLG priority
srlg-index: integer: SRLG index
range:"1..65535"
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

a2_interface-srlg-names_schema:

SRLG Name configuration for an interface

interface-srlg-name: object[]: SRLG name data
object srlg-name: string SRLG name

Example

{
  "interface-srlg-name": [
    {
      "srlg-name": "string"
    }
  ]
}

a2_interface-srlg-name_schema:

srlg-name: string: SRLG name

Example

{
  "srlg-name": "string"
}

a2_srlg-names_schema:

Set of SRLG name configuration

srlg-name: object[]: SRLG name configuration
object srlg-name: string SRLG name srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "srlg-name": [
    {
      "srlg-name": "string",
      "srlg-value": "integer"
    }
  ]
}

a2_srlg-name_schema:

srlg-name: string: SRLG name
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-name": "string",
  "srlg-value": "integer"
}

a2_groups_schema:

Define a User Security Model group

group: object[]: Name of the group
object name: string Name of the group write-view: string write view name snmp-version: string v1, v2c, v3 snmp version context-name: string Context name security-model: string no-authentication, authentication, privacy security model like auth/noAuth/Priv applicable for v3 v6acl-type: string ipv4, ipv6 Access-list type v6-access-list: string Ipv6 Access-list name read-view: string read view name v4acl-type: string ipv4, ipv6 Access-list type v4-access-list: string Ipv4 Access-list name notify-view: string notify view name

Example

{
  "group": [
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

a2_group_schema:

name: string: Name of the group
write-view: string: write view name
snmp-version: string v1, v2c, v3: snmp version
context-name: string: Context name
security-model: string no-authentication, authentication, privacy: security model like auth/noAuth/Priv applicable for v3
v6acl-type: string ipv4, ipv6: Access-list type
v6-access-list: string: Ipv6 Access-list name
read-view: string: read view name
v4acl-type: string ipv4, ipv6: Access-list type
v4-access-list: string: Ipv4 Access-list name
notify-view: string: notify view name

Example

{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

a2_group-values_schema:

Set of SRLG values configured under a group

group-value: object[]: Group SRLG values with attribute
object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "group-value": [
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

a2_group-value_schema:

srlg-priority: string critical, high, default, low, very-low: SRLG priority
srlg-index: integer: SRLG index
range:"1..65535"
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

a2_inherit-nodes_schema:

Set of inherit nodes configured with SRLG

inherit-node: object[]: Inherit node configurations
object enable: null Enable SRLG inherit node inherit-node-values: object Set of SRLG values configured under an inherit node inherit-node-value: object[] Inherit node SRLG value with attributes object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295" inherit-node-name: string The inherit node name

Example

{
  "inherit-node": [
    {
      "enable": [ null ],
      "inherit-node-values": {
        "inherit-node-value": [
          {
            "srlg-priority": "string",
            "srlg-index": "integer",
            "srlg-value": "integer"
          }
        ]
      },
      "inherit-node-name": "string"
    }
  ]
}

a2_inherit-node_schema:

enable: null: Enable SRLG inherit node
inherit-node-values: object: Set of SRLG values configured under an inherit node
inherit-node-value: object[] Inherit node SRLG value with attributes object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"
inherit-node-name: string: The inherit node name

Example

{
  "enable": [ null ],
  "inherit-node-values": {
    "inherit-node-value": [
      {
        "srlg-priority": "string",
        "srlg-index": "integer",
        "srlg-value": "integer"
      }
    ]
  },
  "inherit-node-name": "string"
}

a2_inherit-node-values_schema:

Set of SRLG values configured under an inherit node

inherit-node-value: object[]: Inherit node SRLG value with attributes
object srlg-priority: string critical, high, default, low, very-low SRLG priority srlg-index: integer SRLG index range:"1..65535" srlg-value: integer SRLG value range:"0..4294967295"

Example

{
  "inherit-node-value": [
    {
      "srlg-priority": "string",
      "srlg-index": "integer",
      "srlg-value": "integer"
    }
  ]
}

a2_inherit-node-value_schema:

srlg-priority: string critical, high, default, low, very-low: SRLG priority
srlg-index: integer: SRLG index
range:"1..65535"
srlg-value: integer: SRLG value
range:"0..4294967295"

Example

{
  "srlg-priority": "string",
  "srlg-index": "integer",
  "srlg-value": "integer"
}

a2_vrf-groups_schema:

vrf groups

vrf-group: object[]: VRF group configuration
object enable: null Enable VRF group vrfs: object Set of VRFs configured under a VRF group vrf: object[] VRF configuration object vrf-name: string VRF name vrf-group-name: string VRF group name

Example

{
  "vrf-group": [
    {
      "enable": [ null ],
      "vrfs": {
        "vrf": [
          {
            "vrf-name": "string"
          }
        ]
      },
      "vrf-group-name": "string"
    }
  ]
}

a2_vrf-group_schema:

enable: null: Enable VRF group
vrfs: object: Set of VRFs configured under a VRF group
vrf: object[] VRF configuration object vrf-name: string VRF name
vrf-group-name: string: VRF group name

Example

{
  "enable": [ null ],
  "vrfs": {
    "vrf": [
      {
        "vrf-name": "string"
      }
    ]
  },
  "vrf-group-name": "string"
}

a2_selective-vrf-download_schema:

CISCO-SELECTIVE-VRF-DOWNLOAD-MIB notification configuration

role-change: null: Enable csvdEntityRoleChangeNotification notification

Example

{
  "role-change": [ null ]
}

a2_global-interface-configuration_schema:

Global scoped configuration for interfaces

link-status: string default, disable, software-interfaces: Enable or disable link-status messages

Example

{
  "link-status": "string"
}

a2_interface-configurations_schema:

interface configurations

interface-configuration: object[]: The configuration for an interface
object dampening: object Whether this interface's state changes are dampened or not args: string default-values, specify-half-life, specify-all, specify-rp Dampening Arguments suppress-threshold: integer Suppress threshold range:"1..20000" half-life: integer Decay half life (in minutes) range:"1..45" units:"minute" suppress-time: integer Max suppress time (in minutes) range:"1..255" units:"minute" reuse-threshold: integer Reuse threshold range:"1..20000" restart-penalty: integer Restart penalty range:"0..20000" description: string The description of this interface secondary-admin-state: string normal, maintenance The secondary admin state of the interface interface-virtual: null The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface. link-status: null Enable interface and line-protocol state change alarms bandwidth: integer The bandwidth of the interface in kbps range:"0..4294967295" units:"kbit/s" mtus: object The MTU configuration for the interface mtu: object[] The MTU for the interface object owner: string The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback' mtu: integer The MTU value range:"64..65535" vrf: string Assign the interface to a VRF shutdown: null The existence of this configuration indicates the interface is shut down active: string Whether the interface is active or preconfigured encapsulation: object The encapsulation on the interface encapsulation: string The encapsulation - e.g. hdlc, ppp capsulation-options: integer The options for this capsulation, usually '0' interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport The mode in which an interface is running. The existence of this object causes the creation of the software subinterface. interface-name: string The name of the interface afs: object Per-address-family and topology configuration af-topology-name: object[] The presence of this object enables the givenaddress-family and topology on the interface. object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family topology-name: string Topology name af: object[] The presence of this object enables the givenaddress-family and topology on the interface. object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family

Example

{
  "interface-configuration": [
    {
      "dampening": {
        "args": "string",
        "suppress-threshold": "integer",
        "half-life": "integer",
        "suppress-time": "integer",
        "reuse-threshold": "integer",
        "restart-penalty": "integer"
      },
      "description": "string",
      "secondary-admin-state": "string",
      "interface-virtual": [ null ],
      "link-status": [ null ],
      "bandwidth": "integer",
      "mtus": {
        "mtu": [
          {
            "owner": "string",
            "mtu": "integer"
          }
        ]
      },
      "vrf": "string",
      "shutdown": [ null ],
      "active": "string",
      "encapsulation": {
        "encapsulation": "string",
        "capsulation-options": "integer"
      },
      "interface-mode-non-physical": "string",
      "interface-name": "string",
      "afs": {
        "af-topology-name": [
          {
            "af-name": "string",
            "saf-name": "string",
            "topology-name": "string"
          }
        ],
        "af": [
          {
            "af-name": "string",
            "saf-name": "string"
          }
        ]
      }
    }
  ]
}

a2_interface-configuration_schema:

dampening: object: Whether this interface's state changes are dampened or not
args: string default-values, specify-half-life, specify-all, specify-rp Dampening Arguments suppress-threshold: integer Suppress threshold range:"1..20000" half-life: integer Decay half life (in minutes) range:"1..45" units:"minute" suppress-time: integer Max suppress time (in minutes) range:"1..255" units:"minute" reuse-threshold: integer Reuse threshold range:"1..20000" restart-penalty: integer Restart penalty range:"0..20000"
description: string: The description of this interface
secondary-admin-state: string normal, maintenance: The secondary admin state of the interface
interface-virtual: null: The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.
link-status: null: Enable interface and line-protocol state change alarms
bandwidth: integer: The bandwidth of the interface in kbps
range:"0..4294967295" units:"kbit/s"
mtus: object: The MTU configuration for the interface
mtu: object[] The MTU for the interface object owner: string The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback' mtu: integer The MTU value range:"64..65535"
vrf: string: Assign the interface to a VRF
shutdown: null: The existence of this configuration indicates the interface is shut down
active: string: Whether the interface is active or preconfigured
encapsulation: object: The encapsulation on the interface
encapsulation: string The encapsulation - e.g. hdlc, ppp capsulation-options: integer The options for this capsulation, usually '0'
interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport: The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.
interface-name: string: The name of the interface
afs: object: Per-address-family and topology configuration
af-topology-name: object[] The presence of this object enables the givenaddress-family and topology on the interface. object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family topology-name: string Topology name af: object[] The presence of this object enables the givenaddress-family and topology on the interface. object af-name: string ipv4, ipv6 Address-family saf-name: string unicast, multicast, flow-spec Sub-address-family

Example

{
  "dampening": {
    "args": "string",
    "suppress-threshold": "integer",
    "half-life": "integer",
    "suppress-time": "integer",
    "reuse-threshold": "integer",
    "restart-penalty": "integer"
  },
  "description": "string",
  "secondary-admin-state": "string",
  "interface-virtual": [ null ],
  "link-status": [ null ],
  "bandwidth": "integer",
  "mtus": {
    "mtu": [
      {
        "owner": "string",
        "mtu": "integer"
      }
    ]
  },
  "vrf": "string",
  "shutdown": [ null ],
  "active": "string",
  "encapsulation": {
    "encapsulation": "string",
    "capsulation-options": "integer"
  },
  "interface-mode-non-physical": "string",
  "interface-name": "string",
  "afs": {
    "af-topology-name": [
      {
        "af-name": "string",
        "saf-name": "string",
        "topology-name": "string"
      }
    ],
    "af": [
      {
        "af-name": "string",
        "saf-name": "string"
      }
    ]
  }
}

a2_dampening_schema:

Whether this interface's state changes are dampened or not

args: string default-values, specify-half-life, specify-all, specify-rp: Dampening Arguments
suppress-threshold: integer: Suppress threshold
range:"1..20000"
half-life: integer: Decay half life (in minutes)
range:"1..45" units:"minute"
suppress-time: integer: Max suppress time (in minutes)
range:"1..255" units:"minute"
reuse-threshold: integer: Reuse threshold
range:"1..20000"
restart-penalty: integer: Restart penalty
range:"0..20000"

Example

{
  "args": "string",
  "suppress-threshold": "integer",
  "half-life": "integer",
  "suppress-time": "integer",
  "reuse-threshold": "integer",
  "restart-penalty": "integer"
}

a2_mtus_schema:

The MTU configuration for the interface

mtu: object[]: The MTU for the interface
object owner: string The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback' mtu: integer The MTU value range:"64..65535"

Example

{
  "mtu": [
    {
      "owner": "string",
      "mtu": "integer"
    }
  ]
}

a2_mtu_schema:

owner: string: The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
mtu: integer: The MTU value
range:"64..65535"

Example

{
  "owner": "string",
  "mtu": "integer"
}

a2_encapsulation_schema:

The encapsulation on the interface

encapsulation: string: The encapsulation - e.g. hdlc, ppp
capsulation-options: integer: The options for this capsulation, usually '0'

Example

{
  "encapsulation": "string",
  "capsulation-options": "integer"
}

a2_af-topology-name_schema:

af-name: string ipv4, ipv6: Address-family
saf-name: string unicast, multicast, flow-spec: Sub-address-family
topology-name: string: Topology name

Example

{
  "af-name": "string",
  "saf-name": "string",
  "topology-name": "string"
}

TRAP-HOST-TABLE:

Common node of snmp, vrf

trap-hosts: object: Specify hosts to receive SNMP notifications
trap-host: object[] Specify hosts to receive SNMP notifications object encrypted-user-communities: object Container class for defining Clear/encrypt communities for a trap host encrypted-user-community: object[] Clear/Encrypt Community name associated with a trap host object port: string UDP port number version: string SNMP Version to be used v1/v2c/v3 community-name: string SNMPv1/v2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used inform-host: object Container class for defining notification type for a Inform host inform-encrypted-user-communities: object Container class for defining Clear/encrypt communities for a inform host inform-encrypted-user-community: object[] Clear/Encrypt Community name associated with a inform host object port: string UDP port number version: string SNMP Version to be used v2c/v3 community-name: string SNMPv2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used inform-user-communities: object Container class for defining communities for a inform host inform-user-community: object[] Unencrpted Community name associated with a inform host object port: string UDP port number version: string SNMP Version to be used v2c/v3 community-name: string SNMPv2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used ip-address: string IP address of SNMP notification host default-user-communities: object Container class for defining communities for a trap host default-user-community: object[] Unencrpted Community name associated with a trap host object port: string UDP port number version: string SNMP Version to be used v1/v2c/v3 community-name: string SNMPv1/v2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "trap-hosts": {
    "trap-host": [
      {
        "encrypted-user-communities": {
          "encrypted-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        "inform-host": {
          "inform-encrypted-user-communities": {
            "inform-encrypted-user-community": [
              {
                "port": "string",
                "version": "string",
                "community-name": "string",
                "basic-trap-types": "integer",
                "advanced-trap-types2": "integer",
                "security-level": "string",
                "advanced-trap-types1": "integer"
              }
            ]
          },
          "inform-user-communities": {
            "inform-user-community": [
              {
                "port": "string",
                "version": "string",
                "community-name": "string",
                "basic-trap-types": "integer",
                "advanced-trap-types2": "integer",
                "security-level": "string",
                "advanced-trap-types1": "integer"
              }
            ]
          }
        },
        "ip-address": "string",
        "default-user-communities": {
          "default-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      }
    ]
  }
}

APPLIED-TO:

Common node of rule, rule-set

applied-to: object: Applied to the Rule or Ruleset
all: null Apply to all of the device hosts: object Table of configured hosts to apply rules to host: object[] A destination host object port: string Port (specify 162 for default) ip-address: string IP address

Example

{
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

CONTEXT-MAPPING-TABLE:

Common node of snmp, vrf

context-mappings: object: List of context names
context-mapping: object[] Context mapping name object context-mapping-name: string Context mapping name vrf-name: string VRF name associated with the context topology-name: string Topology name associated with the context context: string vrf, bridge, ospf, ospfv3 SNMP context feature type instance-name: string OSPF protocol instance

Example

{
  "context-mappings": {
    "context-mapping": [
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

VAR-BIND-TABLE:

Common node of root-cause, non-root-cause

var-binds: object: Varbinds to match
var-bind: object[] Varbind match conditions object oid: string OID of varbind (dotted decimal) match: object VarBind match conditions index: string Regular Expression to match index value: string Regular Expression to match value

Example

{
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

CONTEXT-TABLE:

Common node of snmp, vrf

contexts: object: List of Context Names
context: object[] Context Name object context-name: string Context Name

Example

{
  "contexts": {
    "context": [
      {
        "context-name": "string"
      }
    ]
  }
}

a2_snmp_schema:

SNMP notification configuration

authentication: null: Enable authentication notification
enable: null: Enable SNMP notifications
warm-start: null: Enable warm start notification
cold-start: null: Enable cold start notification

Example

{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

a2_encrypted-community-maps_schema:

Container class to hold clear/encrypted communitie maps

encrypted-community-map: object[]: Clear/encrypted SNMP community map
object security: string SNMP Security Name community-name: string SNMP community map context: string SNMP Context Name target-list: string target list name

Example

{
  "encrypted-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a2_encrypted-community-map_schema:

security: string: SNMP Security Name
community-name: string: SNMP community map
context: string: SNMP Context Name
target-list: string: target list name

Example

{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a2_views_schema:

Class to configure a SNMPv2 MIB view

view: object[]: Name of the view
object view-name: string Name of the view view-inclusion: string included, excluded MIB view to be included or excluded family: string MIB view family name

Example

{
  "view": [
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

a2_view_schema:

view-name: string: Name of the view
view-inclusion: string included, excluded: MIB view to be included or excluded
family: string: MIB view family name

Example

{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

a2_logging_schema:

SNMP logging

threshold: object: SNMP logging threshold
oid-processing: integer SNMP logging threshold for OID processing range:"0..20000" default:"500" pdu-processing: integer SNMP logging threshold for PDU processing range:"0..20000" default:"20000"

Example

{
  "threshold": {
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

a2_threshold_schema:

SNMP logging threshold

oid-processing: integer: SNMP logging threshold for OID processing
range:"0..20000" default:"500"
pdu-processing: integer: SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"

Example

{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

a2_administration_schema:

Container class for SNMP administration

default-communities: object: Container class to hold unencrpted communities
default-community: object[] Unencrpted SNMP community string and access priviledges object priviledge: string read-only, read-write Read/Write Access view-name: string MIB view to which the community has access v6acl-type: string ipv4, ipv6 Access-list type v6-access-list: string Ipv6 Access-list name community-name: string SNMP community string owner: string sdr-owner, system-owner Logical Router or System owner access v4acl-type: string ipv4, ipv6 Access-list type v4-access-list: string Ipv4 Access-list name
encrypted-communities: object: Container class to hold clear/encrypted communities
encrypted-community: object[] Clear/encrypted SNMP community string and access priviledges object priviledge: string read-only, read-write Read/Write Access view-name: string MIB view to which the community has access v6acl-type: string ipv4, ipv6 Access-list type v6-access-list: string Ipv6 Access-list name community-name: string SNMP community string owner: string sdr-owner, system-owner Logical Router or System owner access v4acl-type: string ipv4, ipv6 Access-list type v4-access-list: string Ipv4 Access-list name

Example

{
  "default-communities": {
    "default-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  "encrypted-communities": {
    "encrypted-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

a2_default-communities_schema:

Container class to hold unencrpted communities

default-community: object[]: Unencrpted SNMP community string and access priviledges
object priviledge: string read-only, read-write Read/Write Access view-name: string MIB view to which the community has access v6acl-type: string ipv4, ipv6 Access-list type v6-access-list: string Ipv6 Access-list name community-name: string SNMP community string owner: string sdr-owner, system-owner Logical Router or System owner access v4acl-type: string ipv4, ipv6 Access-list type v4-access-list: string Ipv4 Access-list name

Example

{
  "default-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a2_default-community_schema:

priviledge: string read-only, read-write: Read/Write Access
view-name: string: MIB view to which the community has access
v6acl-type: string ipv4, ipv6: Access-list type
v6-access-list: string: Ipv6 Access-list name
community-name: string: SNMP community string
owner: string sdr-owner, system-owner: Logical Router or System owner access
v4acl-type: string ipv4, ipv6: Access-list type
v4-access-list: string: Ipv4 Access-list name

Example

{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a2_encrypted-communities_schema:

Container class to hold clear/encrypted communities

encrypted-community: object[]: Clear/encrypted SNMP community string and access priviledges
object priviledge: string read-only, read-write Read/Write Access view-name: string MIB view to which the community has access v6acl-type: string ipv4, ipv6 Access-list type v6-access-list: string Ipv6 Access-list name community-name: string SNMP community string owner: string sdr-owner, system-owner Logical Router or System owner access v4acl-type: string ipv4, ipv6 Access-list type v4-access-list: string Ipv4 Access-list name

Example

{
  "encrypted-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a2_encrypted-community_schema:

priviledge: string read-only, read-write: Read/Write Access
view-name: string: MIB view to which the community has access
v6acl-type: string ipv4, ipv6: Access-list type
v6-access-list: string: Ipv6 Access-list name
community-name: string: SNMP community string
owner: string sdr-owner, system-owner: Logical Router or System owner access
v4acl-type: string ipv4, ipv6: Access-list type
v4-access-list: string: Ipv4 Access-list name

Example

{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a2_agent_schema:

The heirarchy point for SNMP Agent configurations

engine-id: object: SNMPv3 engineID
remotes: object SNMPv3 remote SNMP Entity remote: object[] engineID of the remote agent object remote-engine-id: string engine ID octet string remote-address: string IP address of remote SNMP entity port: string UDP port number local: string engineID of the local agent

Example

{
  "engine-id": {
    "remotes": {
      "remote": [
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

a2_engine-id_schema:

SNMPv3 engineID

remotes: object: SNMPv3 remote SNMP Entity
remote: object[] engineID of the remote agent object remote-engine-id: string engine ID octet string remote-address: string IP address of remote SNMP entity port: string UDP port number
local: string: engineID of the local agent

Example

{
  "remotes": {
    "remote": [
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

a2_remotes_schema:

SNMPv3 remote SNMP Entity

remote: object[]: engineID of the remote agent
object remote-engine-id: string engine ID octet string remote-address: string IP address of remote SNMP entity port: string UDP port number

Example

{
  "remote": [
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

a2_remote_schema:

remote-engine-id: string: engine ID octet string
remote-address: string: IP address of remote SNMP entity
port: string: UDP port number

Example

{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

a2_trap_schema:

Class to hold trap configurations

queue-length: integer: Message queue length for each TRAP host
range:"1..5000"
throttle-time: integer: Set throttle time for handling traps
range:"50..1000" units:"millisecond"
timeout: integer: Timeout for TRAP message retransmissions
range:"1..600000" units:"millisecond"

Example

{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

a2_drop-packet_schema:

SNMP packet drop config

unknown-user: null: Enable drop unknown user name

Example

{
  "unknown-user": [ null ]
}

a2_ipv6_schema:

SNMP TOS bit for outgoing packets

tos: object: Type of TOS
type: string precedence, dscp SNMP TOS type DSCP or Precedence dscp: string SNMP DSCP value precedence: string SNMP Precedence value

Example

{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a2_tos_schema:

Type of TOS

type: string precedence, dscp: SNMP TOS type DSCP or Precedence
dscp: string: SNMP DSCP value
precedence: string: SNMP Precedence value

Example

{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

a2_ipv4_schema:

SNMP TOS bit for outgoing packets

tos: object: Type of TOS
type: string precedence, dscp SNMP TOS type DSCP or Precedence dscp: string SNMP DSCP value precedence: string SNMP Precedence value

Example

{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a2_system_schema:

container to hold system information

chassis-id: string: String to uniquely identify this chassis
contact: string: identification of the contact person for this managed node
location: string: The physical location of this node

Example

{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

a2_target_schema:

target-addresses: object: SNMP Target address configurations
target-address: object[] IP Address to be configured for the Target object ip-address: string IPv4/Ipv6 address
target-list-name: string: Name of the target list
vrf-names: object: List of VRF Name for a target list
vrf-name: object[] VRF name of the target object name: string VRF Name

Example

{
  "target-addresses": {
    "target-address": [
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  "vrf-names": {
    "vrf-name": [
      {
        "name": "string"
      }
    ]
  }
}

a2_targets_schema:

List of targets

target: object[]: Name of the target list
object target-addresses: object SNMP Target address configurations target-address: object[] IP Address to be configured for the Target object ip-address: string IPv4/Ipv6 address target-list-name: string Name of the target list vrf-names: object List of VRF Name for a target list vrf-name: object[] VRF name of the target object name: string VRF Name

Example

{
  "target": [
    {
      "target-addresses": {
        "target-address": [
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      "vrf-names": {
        "vrf-name": [
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

a2_vrf-names_schema:

List of VRF Name for a target list

vrf-name: object[]: VRF name of the target
object name: string VRF Name

Example

{
  "vrf-name": [
    {
      "name": "string"
    }
  ]
}

a2_vrf-name_schema:

name: string: VRF Name

Example

{
  "name": "string"
}

a2_target-addresses_schema:

SNMP Target address configurations

target-address: object[]: IP Address to be configured for the Target
object ip-address: string IPv4/Ipv6 address

Example

{
  "target-address": [
    {
      "ip-address": "string"
    }
  ]
}

a2_target-address_schema:

ip-address: string: IPv4/Ipv6 address

Example

{
  "ip-address": "string"
}

a2_notification_schema:

Enable SNMP notifications

selective-vrf-download: object: CISCO-SELECTIVE-VRF-DOWNLOAD-MIB notification configuration
role-change: null Enable csvdEntityRoleChangeNotification notification
snmp: object: SNMP notification configuration
authentication: null Enable authentication notification enable: null Enable SNMP notifications warm-start: null Enable warm start notification cold-start: null Enable cold start notification

Example

{
  "selective-vrf-download": {
    "role-change": [ null ]
  },
  "snmp": {
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}

a2_correlator_schema:

Configure properties of the trap correlator

rules: object: Table of configured rules
rule: object[] Rule name APPLIED-TO non-root-causes: object Table of configured non-rootcause non-root-cause: object[] A non-rootcause VAR-BIND-TABLE oid: string OID of nonrootcause trap (dotted decimal) created: null Create nonrootcause timeout: integer Timeout (time to wait for active correlation) in milliseconds range:"1..600000" units:"millisecond" root-causes: object Table of configured rootcause (only one entry allowed) root-cause: object[] The rootcause - maximum of one can be configured per rule VAR-BIND-TABLE oid: string OID of rootcause trap (dotted decimal) created: null Create rootcause name: string Rule name
rule-sets: object: Table of configured rulesets
rule-set: object[] Ruleset name APPLIED-TO name: string Ruleset name rulenames: object Table of configured rulenames rulename: object[] A rulename object rulename: string Rule name
buffer-size: integer: Configure size of the correlator buffer
range:"1024..2147483647" units:"byte"

Example

{
  "rules": {
    "rule": [
      {
        "non-root-causes": {
          "non-root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        "root-causes": {
          "root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "rule-sets": {
    "rule-set": [
      {
        "name": "string",
        "rulenames": {
          "rulename": [
            {
              "rulename": "string"
            }
          ]
        },
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

a2_rules_schema:

Table of configured rules

rule: object[]: Rule name
APPLIED-TO non-root-causes: object Table of configured non-rootcause non-root-cause: object[] A non-rootcause VAR-BIND-TABLE oid: string OID of nonrootcause trap (dotted decimal) created: null Create nonrootcause timeout: integer Timeout (time to wait for active correlation) in milliseconds range:"1..600000" units:"millisecond" root-causes: object Table of configured rootcause (only one entry allowed) root-cause: object[] The rootcause - maximum of one can be configured per rule VAR-BIND-TABLE oid: string OID of rootcause trap (dotted decimal) created: null Create rootcause name: string Rule name

Example

{
  "rule": [
    {
      "non-root-causes": {
        "non-root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      "root-causes": {
        "root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a2_rule_schema:

APPLIED-TO

non-root-causes: object: Table of configured non-rootcause
non-root-cause: object[] A non-rootcause VAR-BIND-TABLE oid: string OID of nonrootcause trap (dotted decimal) created: null Create nonrootcause
timeout: integer: Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond"
root-causes: object: Table of configured rootcause (only one entry allowed)
root-cause: object[] The rootcause - maximum of one can be configured per rule VAR-BIND-TABLE oid: string OID of rootcause trap (dotted decimal) created: null Create rootcause
name: string: Rule name

Example

{
  "non-root-causes": {
    "non-root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  "root-causes": {
    "root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a2_root-causes_schema:

Table of configured rootcause (only one entry allowed)

root-cause: object[]: The rootcause - maximum of one can be configured per rule
VAR-BIND-TABLE oid: string OID of rootcause trap (dotted decimal) created: null Create rootcause

Example

{
  "root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a2_root-cause_schema:

VAR-BIND-TABLE

oid: string: OID of rootcause trap (dotted decimal)
created: null: Create rootcause

Example

{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a2_var-binds_schema:

Varbinds to match

var-bind: object[]: Varbind match conditions
object oid: string OID of varbind (dotted decimal) match: object VarBind match conditions index: string Regular Expression to match index value: string Regular Expression to match value

Example

{
  "var-bind": [
    {
      "oid": "string",
      "match": {
        "index": "string",
        "value": "string"
      }
    }
  ]
}

a2_var-bind_schema:

oid: string: OID of varbind (dotted decimal)
match: object: VarBind match conditions
index: string Regular Expression to match index value: string Regular Expression to match value

Example

{
  "oid": "string",
  "match": {
    "index": "string",
    "value": "string"
  }
}

a2_match_schema:

VarBind match conditions

index: string: Regular Expression to match index
value: string: Regular Expression to match value

Example

{
  "index": "string",
  "value": "string"
}

a2_non-root-causes_schema:

Table of configured non-rootcause

non-root-cause: object[]: A non-rootcause
VAR-BIND-TABLE oid: string OID of nonrootcause trap (dotted decimal) created: null Create nonrootcause

Example

{
  "non-root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a2_non-root-cause_schema:

VAR-BIND-TABLE

oid: string: OID of nonrootcause trap (dotted decimal)
created: null: Create nonrootcause

Example

{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a2_applied-to_schema:

Applied to the Rule or Ruleset

all: null: Apply to all of the device
hosts: object: Table of configured hosts to apply rules to
host: object[] A destination host object port: string Port (specify 162 for default) ip-address: string IP address

Example

{
  "all": [ null ],
  "hosts": {
    "host": [
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

a2_hosts_schema:

Table of configured hosts to apply rules to

host: object[]: A destination host
object port: string Port (specify 162 for default) ip-address: string IP address

Example

{
  "host": [
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

a2_host_schema:

port: string: Port (specify 162 for default)
ip-address: string: IP address

Example

{
  "port": "string",
  "ip-address": "string"
}

a2_rule-sets_schema:

Table of configured rulesets

rule-set: object[]: Ruleset name
APPLIED-TO name: string Ruleset name rulenames: object Table of configured rulenames rulename: object[] A rulename object rulename: string Rule name

Example

{
  "rule-set": [
    {
      "name": "string",
      "rulenames": {
        "rulename": [
          {
            "rulename": "string"
          }
        ]
      },
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a2_rule-set_schema:

APPLIED-TO

name: string: Ruleset name
rulenames: object: Table of configured rulenames
rulename: object[] A rulename object rulename: string Rule name

Example

{
  "name": "string",
  "rulenames": {
    "rulename": [
      {
        "rulename": "string"
      }
    ]
  },
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a2_rulenames_schema:

Table of configured rulenames

rulename: object[]: A rulename
object rulename: string Rule name

Example

{
  "rulename": [
    {
      "rulename": "string"
    }
  ]
}

a2_rulename_schema:

rulename: string: Rule name

Example

{
  "rulename": "string"
}

a2_bulk-stats_schema:

SNMP bulk stats configuration commands

memory: integer: per process memory limit in kilo bytes
range:"100..200000" units:"kilobyte"
transfers: object: Periodicity for the transfer of bulk data in minutes
transfer: object[] Name of bulk transfer object retry: integer Number of transmission retries range:"0..100" transfer-schemas: object Schema that contains objects to be collected transfer-schema: object[] Schema that contains objects to be collected object schema-name: string Schema that contains objects to be collected format: string schema-ascii, bulk-ascii, bulk-binary Format of the bulk data file interval: integer Periodicity for the transfer of bulk data in minutes units:"minute" primary: string FTP or rcp or TFTP can be used for file transfer buffer-size: integer Bulkstat data file maximum size in bytes range:"1024..2147483647" units:"byte" enable: null Start Data Collection for this Configuration transfer-name: string Name of bulk transfer retain: integer Retention period in minutes range:"0..20000" units:"minute" type: null Configure transfer list name secondary: string FTP or rcp or TFTP can be used for file transfer
objects: object: Configure an Object List
object: object[] Name of the object List object object-list-name: string Name of the object List objects: object Configure an object List object: object[] Object name or OID object oid: string Object name or OID type: null Configure object list name
schemas: object: Configure schema definition
schema: object[] The name of the Schema object schema-name: string The name of the schema instance: object Object instance information end: string End Instance OID for repetition sub-interface: boolean Include all the subinterface start: string Start Instance OID for repetition max: integer Max value of Instance repetition instance: string Instance of the schema type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid Type of the instance type: null Configure schema name schema-object-list: string Name of an object List poll-interval: integer Periodicity for polling of objects in this schema in minutes range:"1..20000" units:"minute"

Example

{
  "memory": "integer",
  "transfers": {
    "transfer": [
      {
        "retry": "integer",
        "transfer-schemas": {
          "transfer-schema": [
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  "objects": {
    "object": [
      {
        "object-list-name": "string",
        "objects": {
          "object": [
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  "schemas": {
    "schema": [
      {
        "schema-name": "string",
        "instance": {
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

a2_schemas_schema:

Configure schema definition

schema: object[]: The name of the Schema
object schema-name: string The name of the schema instance: object Object instance information end: string End Instance OID for repetition sub-interface: boolean Include all the subinterface start: string Start Instance OID for repetition max: integer Max value of Instance repetition instance: string Instance of the schema type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid Type of the instance type: null Configure schema name schema-object-list: string Name of an object List poll-interval: integer Periodicity for polling of objects in this schema in minutes range:"1..20000" units:"minute"

Example

{
  "schema": [
    {
      "schema-name": "string",
      "instance": {
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

a2_schema_schema:

schema-name: string: The name of the schema
instance: object: Object instance information
end: string End Instance OID for repetition sub-interface: boolean Include all the subinterface start: string Start Instance OID for repetition max: integer Max value of Instance repetition instance: string Instance of the schema type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid Type of the instance
type: null: Configure schema name
schema-object-list: string: Name of an object List
poll-interval: integer: Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"

Example

{
  "schema-name": "string",
  "instance": {
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

a2_instance_schema:

Object instance information

end: string: End Instance OID for repetition
sub-interface: boolean: Include all the subinterface
start: string: Start Instance OID for repetition
max: integer: Max value of Instance repetition
instance: string: Instance of the schema
type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid: Type of the instance

Example

{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

a2_objects_schema:

Configure an object List

object: object[]: Object name or OID
object oid: string Object name or OID

Example

{
  "object": [
    {
      "oid": "string"
    }
  ]
}

a2_object_schema:

oid: string: Object name or OID

Example

{
  "oid": "string"
}

a2_transfers_schema:

Periodicity for the transfer of bulk data in minutes

transfer: object[]: Name of bulk transfer
object retry: integer Number of transmission retries range:"0..100" transfer-schemas: object Schema that contains objects to be collected transfer-schema: object[] Schema that contains objects to be collected object schema-name: string Schema that contains objects to be collected format: string schema-ascii, bulk-ascii, bulk-binary Format of the bulk data file interval: integer Periodicity for the transfer of bulk data in minutes units:"minute" primary: string FTP or rcp or TFTP can be used for file transfer buffer-size: integer Bulkstat data file maximum size in bytes range:"1024..2147483647" units:"byte" enable: null Start Data Collection for this Configuration transfer-name: string Name of bulk transfer retain: integer Retention period in minutes range:"0..20000" units:"minute" type: null Configure transfer list name secondary: string FTP or rcp or TFTP can be used for file transfer

Example

{
  "transfer": [
    {
      "retry": "integer",
      "transfer-schemas": {
        "transfer-schema": [
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

a2_transfer_schema:

retry: integer: Number of transmission retries
range:"0..100"
transfer-schemas: object: Schema that contains objects to be collected
transfer-schema: object[] Schema that contains objects to be collected object schema-name: string Schema that contains objects to be collected
format: string schema-ascii, bulk-ascii, bulk-binary: Format of the bulk data file
interval: integer: Periodicity for the transfer of bulk data in minutes
units:"minute"
primary: string: FTP or rcp or TFTP can be used for file transfer
buffer-size: integer: Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte"
enable: null: Start Data Collection for this Configuration
transfer-name: string: Name of bulk transfer
retain: integer: Retention period in minutes
range:"0..20000" units:"minute"
type: null: Configure transfer list name
secondary: string: FTP or rcp or TFTP can be used for file transfer

Example

{
  "retry": "integer",
  "transfer-schemas": {
    "transfer-schema": [
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

a2_transfer-schemas_schema:

Schema that contains objects to be collected

transfer-schema: object[]: Schema that contains objects to be collected
object schema-name: string Schema that contains objects to be collected

Example

{
  "transfer-schema": [
    {
      "schema-name": "string"
    }
  ]
}

a2_transfer-schema_schema:

schema-name: string: Schema that contains objects to be collected

Example

{
  "schema-name": "string"
}

a2_default-community-maps_schema:

Container class to hold unencrpted community map

default-community-map: object[]: Unencrpted SNMP community map name
object security: string SNMP Security Name community-name: string SNMP community map context: string SNMP Context Name target-list: string target list name

Example

{
  "default-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a2_default-community-map_schema:

security: string: SNMP Security Name
community-name: string: SNMP community map
context: string: SNMP Context Name
target-list: string: target list name

Example

{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a2_overload-control_schema:

Set overload control params for handling incoming messages

drop-time: integer: Drop time in seconds for incoming queue (default 1 sec)
range:"0..300" units:"second"
throttle-rate: integer: Throttle time in milliseconds for incoming queue (default 500 msec)
range:"0..1000" units:"millisecond"

Example

{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

a2_timeouts_schema:

SNMP timeouts

duplicates: integer: Duplicate request feature timeout
range:"0..20" units:"second" default:"1"
pdu-stats: integer: SNMP pdu statistics timeout
range:"1..10" units:"second" default:"2"
in-qdrop: integer: incoming queue drop feature timeout
range:"0..20" units:"second" default:"10"
subagent: integer: Sub-Agent Request timeout
range:"1..20" units:"second" default:"10"

Example

{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

a2_users_schema:

Define a user who can access the SNMP engine

user: object[]: Name of the user
object v6acl-type: string ipv4, ipv6 Access-list type group-name: string Group to which the user belongs v6-access-list: string Ipv6 Access-list name priv-algorithm: string none, des, 3des, aes128, aes192, aes256 The algorithm used des56 or aes128 or aes192or aes256 or 3des owner: string sdr-owner, system-owner The system access either SDROwner or SystemOwner v4acl-type: string ipv4, ipv6 Access-list type privacy-password: string The privacy password remote-address: string IP address of remote SNMP entity port: string UDP port number user-name: string Name of the user algorithm: string none, md5, sha The algorithm used md5 or sha privacy-password-configured: null Flag to indicate that the privacy password is configured for version 3 authentication-password: string The authentication password version: string v1, v2c, v3 SNMP version to be used. v1,v2c or v3 v4-access-list: string Ipv4 Access-list name authentication-password-configured: null Flag to indicate that authentication password is configred for version 3

Example

{
  "user": [
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

a2_user_schema:

v6acl-type: string ipv4, ipv6: Access-list type
group-name: string: Group to which the user belongs
v6-access-list: string: Ipv6 Access-list name
priv-algorithm: string none, des, 3des, aes128, aes192, aes256: The algorithm used des56 or aes128 or aes192or aes256 or 3des
owner: string sdr-owner, system-owner: The system access either SDROwner or SystemOwner
v4acl-type: string ipv4, ipv6: Access-list type
privacy-password: string: The privacy password
remote-address: string: IP address of remote SNMP entity
port: string: UDP port number
user-name: string: Name of the user
algorithm: string none, md5, sha: The algorithm used md5 or sha
privacy-password-configured: null: Flag to indicate that the privacy password is configured for version 3
authentication-password: string: The authentication password
version: string v1, v2c, v3: SNMP version to be used. v1,v2c or v3
v4-access-list: string: Ipv4 Access-list name
authentication-password-configured: null: Flag to indicate that authentication password is configred for version 3

Example

{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

a2_trap-hosts_schema:

Specify hosts to receive SNMP notifications

trap-host: object[]: Specify hosts to receive SNMP notifications
object encrypted-user-communities: object Container class for defining Clear/encrypt communities for a trap host encrypted-user-community: object[] Clear/Encrypt Community name associated with a trap host object port: string UDP port number version: string SNMP Version to be used v1/v2c/v3 community-name: string SNMPv1/v2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used inform-host: object Container class for defining notification type for a Inform host inform-encrypted-user-communities: object Container class for defining Clear/encrypt communities for a inform host inform-encrypted-user-community: object[] Clear/Encrypt Community name associated with a inform host object port: string UDP port number version: string SNMP Version to be used v2c/v3 community-name: string SNMPv2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used inform-user-communities: object Container class for defining communities for a inform host inform-user-community: object[] Unencrpted Community name associated with a inform host object port: string UDP port number version: string SNMP Version to be used v2c/v3 community-name: string SNMPv2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used ip-address: string IP address of SNMP notification host default-user-communities: object Container class for defining communities for a trap host default-user-community: object[] Unencrpted Community name associated with a trap host object port: string UDP port number version: string SNMP Version to be used v1/v2c/v3 community-name: string SNMPv1/v2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "trap-host": [
    {
      "encrypted-user-communities": {
        "encrypted-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      "inform-host": {
        "inform-encrypted-user-communities": {
          "inform-encrypted-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        "inform-user-communities": {
          "inform-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      "default-user-communities": {
        "default-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

a2_trap-host_schema:

encrypted-user-communities: object: Container class for defining Clear/encrypt communities for a trap host
encrypted-user-community: object[] Clear/Encrypt Community name associated with a trap host object port: string UDP port number version: string SNMP Version to be used v1/v2c/v3 community-name: string SNMPv1/v2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
inform-host: object: Container class for defining notification type for a Inform host
inform-encrypted-user-communities: object Container class for defining Clear/encrypt communities for a inform host inform-encrypted-user-community: object[] Clear/Encrypt Community name associated with a inform host object port: string UDP port number version: string SNMP Version to be used v2c/v3 community-name: string SNMPv2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used inform-user-communities: object Container class for defining communities for a inform host inform-user-community: object[] Unencrpted Community name associated with a inform host object port: string UDP port number version: string SNMP Version to be used v2c/v3 community-name: string SNMPv2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
ip-address: string: IP address of SNMP notification host
default-user-communities: object: Container class for defining communities for a trap host
default-user-community: object[] Unencrpted Community name associated with a trap host object port: string UDP port number version: string SNMP Version to be used v1/v2c/v3 community-name: string SNMPv1/v2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "encrypted-user-communities": {
    "encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-host": {
    "inform-encrypted-user-communities": {
      "inform-encrypted-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    "inform-user-communities": {
      "inform-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  "default-user-communities": {
    "default-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a2_encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]: Clear/Encrypt Community name associated with a trap host
object port: string UDP port number version: string SNMP Version to be used v1/v2c/v3 community-name: string SNMPv1/v2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a2_encrypted-user-community_schema:

port: string: UDP port number
version: string: SNMP Version to be used v1/v2c/v3
community-name: string: SNMPv1/v2c community string or SNMPv3 user
basic-trap-types: integer: Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
advanced-trap-types2: integer: Number to signify the feature traps that needs to be setvalue should always to set as 0
security-level: string no-authentication, authentication, privacy: Security level to be used noauth/auth/priv
advanced-trap-types1: integer: Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a2_inform-host_schema:

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object: Container class for defining Clear/encrypt communities for a inform host
inform-encrypted-user-community: object[] Clear/Encrypt Community name associated with a inform host object port: string UDP port number version: string SNMP Version to be used v2c/v3 community-name: string SNMPv2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
inform-user-communities: object: Container class for defining communities for a inform host
inform-user-community: object[] Unencrpted Community name associated with a inform host object port: string UDP port number version: string SNMP Version to be used v2c/v3 community-name: string SNMPv2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "inform-encrypted-user-communities": {
    "inform-encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-user-communities": {
    "inform-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a2_inform-user-communities_schema:

Container class for defining communities for a inform host

inform-user-community: object[]: Unencrpted Community name associated with a inform host
object port: string UDP port number version: string SNMP Version to be used v2c/v3 community-name: string SNMPv2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "inform-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a2_inform-user-community_schema:

port: string: UDP port number
version: string: SNMP Version to be used v2c/v3
community-name: string: SNMPv2c community string or SNMPv3 user
basic-trap-types: integer: Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
advanced-trap-types2: integer: Number to signify the feature traps that needs to be setvalue should always to set as 0
security-level: string no-authentication, authentication, privacy: Security level to be used noauth/auth/priv
advanced-trap-types1: integer: Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a2_inform-encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]: Clear/Encrypt Community name associated with a inform host
object port: string UDP port number version: string SNMP Version to be used v2c/v3 community-name: string SNMPv2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "inform-encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a2_inform-encrypted-user-community_schema:

port: string: UDP port number
version: string: SNMP Version to be used v2c/v3
community-name: string: SNMPv2c community string or SNMPv3 user
basic-trap-types: integer: Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
advanced-trap-types2: integer: Number to signify the feature traps that needs to be setvalue should always to set as 0
security-level: string no-authentication, authentication, privacy: Security level to be used noauth/auth/priv
advanced-trap-types1: integer: Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a2_default-user-communities_schema:

Container class for defining communities for a trap host

default-user-community: object[]: Unencrpted Community name associated with a trap host
object port: string UDP port number version: string SNMP Version to be used v1/v2c/v3 community-name: string SNMPv1/v2c community string or SNMPv3 user basic-trap-types: integer Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps advanced-trap-types2: integer Number to signify the feature traps that needs to be setvalue should always to set as 0 security-level: string no-authentication, authentication, privacy Security level to be used noauth/auth/priv advanced-trap-types1: integer Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "default-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a2_default-user-community_schema:

port: string: UDP port number
version: string: SNMP Version to be used v1/v2c/v3
community-name: string: SNMPv1/v2c community string or SNMPv3 user
basic-trap-types: integer: Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
advanced-trap-types2: integer: Number to signify the feature traps that needs to be setvalue should always to set as 0
security-level: string no-authentication, authentication, privacy: Security level to be used noauth/auth/priv
advanced-trap-types1: integer: Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example

{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a2_contexts_schema:

List of Context Names

context: object[]: Context Name
object context-name: string Context Name

Example

{
  "context": [
    {
      "context-name": "string"
    }
  ]
}

a2_context_schema:

context-name: string: Context Name

Example

{
  "context-name": "string"
}

a2_context-mappings_schema:

List of context names

context-mapping: object[]: Context mapping name
object context-mapping-name: string Context mapping name vrf-name: string VRF name associated with the context topology-name: string Topology name associated with the context context: string vrf, bridge, ospf, ospfv3 SNMP context feature type instance-name: string OSPF protocol instance

Example

{
  "context-mapping": [
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

a2_context-mapping_schema:

context-mapping-name: string: Context mapping name
vrf-name: string: VRF name associated with the context
topology-name: string: Topology name associated with the context
context: string vrf, bridge, ospf, ospfv3: SNMP context feature type
instance-name: string: OSPF protocol instance

Example

{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

a2_mib_schema:

mib